developer.sailpoint.com/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
v2024-access-request-identity-metrics	AccessRequestIdentityMetrics	AccessRequestIdentityMetrics	AccessRequestIdentityMetrics	powershellsdk	powershell PowerShell sdk AccessRequestIdentityMetrics V2024AccessRequestIdentityMetrics	/tools/sdk/powershell/v2024/methods/access-request-identity-metrics	SDK Software Development Kit AccessRequestIdentityMetrics V2024AccessRequestIdentityMetrics

AccessRequestIdentityMetrics

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

Method	HTTP request	Description
Get-V2024AccessRequestIdentityMetrics	GET /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.

Parameters

Param Type	Name	Data Type	Required	Description
Path	IdentityId	String	True	Manager's identity ID.
Path	RequestedObjectId	String	True	Requested access item's ID.
Path	Type	String	True	Requested access item's type.
XSailPointExperimental	String	True (default to "true")	Use this header to enable this experimental API.

Return type

SystemCollectionsHashtable

Responses

Code	Description	Data Type
200	Summary of the resource access and source activity for the direct reports of the provided manager.	SystemCollectionsHashtable
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too 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.	ListAccessProfiles429Response
500	Internal 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.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Return access request identity metrics
try {
    Get-V2024AccessRequestIdentityMetrics-V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2024AccessRequestIdentityMetrics -V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics"
    Write-Host $_.ErrorDetails
}

[Back to top]