Skip to main content

Retrieves potential role source usage

GET 

/role-mining-potential-roles/:potentialRoleId/sources/:sourceId/identityUsage

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role.

Request

Path Parameters

    potentialRoleId stringrequired

    A potential role id

    Example: e0cc5d7d-bf7f-4f81-b2af-8885b09d9923
    sourceId stringrequired

    A source id

    Example: 2c9180877620c1460176267f336a106f

Query Parameters

    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: displayName, email, usageCount

    Example: -usageCount
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

Succeeded. Returns a list of source usage for the identities in a potential role.

Schema

  • Array [

  • id string

    The identity ID

    displayName string

    Display name for the identity

    email string

    Email address for the identity

    usageCount int32

    The number of days there has been usage of the source by the identity.

  • ]

Loading...