Skip to main content

Get a role mining session

GET 

/role-mining-sessions/:sessionId

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.

The method retrieves a role mining session.

Request

Path Parameters

    sessionId stringrequired

    The role mining session id to be retrieved.

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

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

Returns a role mining session

Schema

    scope

    object

    The scope of identities for this role mining session

    identityIds string[]

    The list of identities for this role mining session.

    criteria stringnullable

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

    attributeFilterCriteria object[]nullable

    The filter criteria for this role mining session.

    minNumIdentitiesInPotentialRole integernullable

    Minimum number of identities in a potential role

    scopingMethod stringnullable

    The scoping method of the role mining session

    prescribedPruneThreshold integernullable

    The computed (or prescribed) prune threshold for this session

    pruneThreshold integernullable

    The prune threshold to be used for this role mining session

    potentialRoleCount integer

    The number of potential roles

    potentialRolesReadyCount integer

    The number of potential roles which have completed processing

    status

    object

    The role mining session status

    state RoleMiningSessionState (string)

    Possible values: [CREATED, UPDATED, IDENTITIES_OBTAINED, PRUNE_THRESHOLD_OBTAINED, POTENTIAL_ROLES_PROCESSING, POTENTIAL_ROLES_CREATED]

    Role mining session state

    emailRecipientId stringnullable

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

    createdBy

    object

    The session created by details

    oneOf

    id string

    ID of the creator

    displayName string

    The display name of the creator

    identityCount integer

    The number of identities

    saved boolean

    The session's saved status

    name stringnullable

    The session's saved name

    dataFilePath stringnullable

    The data file path of the role mining session

    id string

    Session Id for this role mining session

    createdDate date-time

    The date-time when this role mining session was created.

    modifiedDate date-time

    The date-time when this role mining session was completed.

    type RoleMiningRoleType (string)

    Possible values: [SPECIALIZED, COMMON]

    Role mining session type

Loading...