Skip to main content

AccessRequestIdentityMetrics

Use this API to implement access request identity metrics functionality. With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions.

All URIs are relative to https://sailpoint.api.identitynow.com/beta

MethodHTTP requestDescription
Get-BetaAccessRequestIdentityMetricsGET /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}Return access request identity metrics

get-access-request-identity-metrics

Use this API to return information access metrics.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
PathIdentityIdStringTrueManager's identity ID.
PathRequestedObjectIdStringTrueRequested access item's ID.
PathTypeStringTrueRequested access item's type.

Return type

SystemCollectionsHashtable

Responses

CodeDescriptionData Type
200Summary of the resource access and source activity for the direct reports of the provided manager.SystemCollectionsHashtable
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.ListAccessModelMetadataAttribute429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID.
$RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID.
$Type = "ENTITLEMENT" # String | Requested access item's type.

# Return access request identity metrics

try {
Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type

# Below is a request that includes all optional parameters
# Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics"
Write-Host $_.ErrorDetails
}

[Back to top]