Skip to main content

Retrieves entitlements for a potential role in a role mining session

GET 

/role-mining-sessions/:sessionId/potential-roles/:potentialRoleId/entitlement-popularities

This method returns entitlements for a potential role in a role mining session.

Request

Path Parameters

    sessionId stringrequired

    The role mining session id

    Example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
    potentialRoleId stringrequired

    A potential role id in a role mining session

    Example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb

Query Parameters

    includeCommonAccess boolean

    Boolean determining whether common access entitlements will be included or not

    sorters string

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

    Sorting is supported for the following fields: popularity

    The default sort is popularity in descending order.

    Example: popularity
    filters string

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

    Filtering is supported for the following fields and operators:

    applicationName: sw

    entitlementRef.name: sw

    Example: applicationName sw "AD"
    offset int32

    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

Responses

Succeeded. Returns a list of entitlements for a potential role.

Schema
  • Array [
  • entitlementRef object

    Details about the entitlement

    id string

    Id of the entitlement

    name string

    Name of the entitlement

    description stringnullable

    Description forthe entitlement

    attribute string

    The entitlement attribute

    name string

    Name of the entitlement

    applicationName string

    Application name of the entitlement

    identityCount int32

    The number of identities with this entitlement in a role.

    popularity float

    The % popularity of this entitlement in a role.

    popularityInOrg float

    The % popularity of this entitlement in the org.

    sourceId string

    The ID of the source/application.

    activitySourceState stringnullable

    The status of activity data for the source. Value is complete or notComplete.

    sourceUsagePercent floatnullable

    The percentage of identities in the potential role that have usage of the source/application of this entitlement.

  • ]
Loading...