Skip to main content

Retrieves all role mining sessions

Returns all role mining sessions that match the query parameters

Query Parameters
  • filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: saved: eq "true" or "false" name: eq, sw

    Example: saved eq "true" and name sw "RM Session"
  • sorters comma-separated

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

    Example: createdBy,createdDate
  • 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 all role mining sessions that match the query parameters.


Schema array
  • scope object

    The scope of identities for this role mining session

  • identityIds string[]

    The list of identities for this role mining session.

  • criteria string

    The "search" criteria that produces the list of identities for this role mining session.

  • attributeFilterCriteria object[]

    The filter criteria for this role mining session.

  • pruneThreshold int32

    The prune threshold to be used or null to calculate prescribedPruneThreshold

  • prescribedPruneThreshold int32

    The calculated prescribedPruneThreshold

  • minNumIdentitiesInPotentialRole int32

    Minimum number of identities in a potential role

  • potentialRoleCount int32

    Number of potential roles

  • potentialRolesReadyCount int32

    Number of potential roles ready

  • status object

    The status of the role mining session

  • state string

    The role mining session status. Can be one of these states - CREATED|UPDATED|IDENTITIES_OBTAINED|PRUNE_THRESHOLD_OBTAINED|POTENTIAL_ROLES_PROCESSING|POTENTIAL_ROLES_CREATED

  • type string

    Possible values: [SPECIALIZED, COMMON]

    Role mining session type

  • emailRecipientId string

    The id of the user who will receive an email about the role mining session

  • createdBy object

    The session created by details

  • id string

    ID of the creator

  • displayName string

    The display name of the creator

  • identityCount int32

    Number of identities in the population which meet the search criteria or identity list provided

  • saved boolean

    The session's saved status

  • name string

    The session's saved name

Loading...