Skip to main content

Get role insights

GET 

/role-insights

This method returns detailed role insights for each role.

Request

Query Parameters

    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
    sorters string

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities

    Example: numberOfUpdates
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    name: sw

    ownerName: sw

    description: sw

    Example: name sw "John"

Responses

Succeeded. Returns a list of roles with information about insights for each role.

Schema

  • Array [

  • id string

    Insight id

    numberOfUpdates integer

    Total number of updates for this role

    createdDate date-time

    The date-time insights were last created for this role.

    modifiedDate date-timenullable

    The date-time insights were last modified for this role.

    role

    object

    A role

    name string

    Role name

    id string

    Role id

    description string

    Role description

    ownerName string

    Role owner name

    ownerId string

    Role owner id

    insight

    object

    The kind of insight this is and some stats

    type string

    The number of identities in this role with the entitlement.

    identitiesWithAccess integer

    The number of identities in this role with the entitlement.

    identitiesImpacted integer

    The number of identities in this role that do not have the specified entitlement.

    totalNumberOfIdentities integer

    The total number of identities.

    impactedIdentityNames stringnullable
  • ]

Loading...