Skip to main content

Retrieves all potential role summaries​

This method returns the potential role summaries for a role mining session.

Path Parameters
  • sessionId string required

    The role mining session id

    Example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
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: createdDate

    Example: createdDate
  • filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: createdById: eq, sw, co createdByName: eq, sw, co description: sw, co endDate: le, lt freshness: eq, ge, gt, le, lt name: eq, sw, co quality: eq, ge, gt, le, lt startDate: ge, gt saved: eq type: eq

    Example: (createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))
  • 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.

  • 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 potential role summaries for a role mining session.

Schema array
  • potentialRoleRef object

    Details about the potential role

  • id string

    Id of the potential role

  • name string

    Name of the potential role

  • identityCount integer

    The number of identities in a potential role.

  • entitlementCount integer

    The number of entitlements in a potential role.

  • identityGroupStatus string

    The status for this identity group which can be "REQUESTED" or "OBTAINED"

  • provisionState string

    Possible values: [POTENTIAL, PENDING, COMPLETE, FAILED]

    The status of provisioning for this potential role. Can be "POTENTIAL", "PENDING", "FAILED", or "COMPLETE".

  • roleId string

    ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned.

  • density integer

    The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities.

  • freshness integer

    The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles.

  • quality integer

    The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness.

Loading...