Skip to main content

Retrieves a specific potential role

GET 

/role-mining-potential-roles/:potentialRoleId

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.

This method returns a specific potential role.

Request

Path Parameters

    potentialRoleId stringrequired

    A potential role id

    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

Succeeded. Returns a list of potential roles for a role mining session.

Schema

    createdBy

    object

    The session created by details

    oneOf

    id string

    ID of the creator

    displayName string

    The display name of the creator

    density int32

    The density of a potential role.

    description stringnullable

    The description of a potential role.

    entitlementCount int32

    The number of entitlements in a potential role.

    excludedEntitlements string[]nullable

    The list of entitlement ids to be excluded.

    freshness int32

    The freshness of a potential role.

    identityCount int32

    The number of identities in a potential role.

    identityDistribution

    object[]

    nullable

    Identity attribute distribution.

  • Array [

  • attributeName string

    Id of the potential role

    distribution object[]
  • ]

  • identityIds string[]

    The list of ids in a potential role.

    name string

    Name of the potential role.

    provisionState RoleMiningPotentialRoleProvisionState (string)nullable

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

    The provisioning state of a potential role.

    quality int32

    The quality of a potential role.

    roleId stringnullable

    The roleId of a potential role.

    saved boolean

    The potential role's saved status.

    session

    object

    The session parameters of the potential role.

    id string

    The ID of the role mining session

    name stringnullable

    The session's saved name

    minNumIdentitiesInPotentialRole int32nullable

    Minimum number of identities in a potential role

    pruneThreshold int32nullable

    The prune threshold to be used or null to calculate prescribedPruneThreshold

    saved boolean

    Default value: true

    The session's saved status

    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.

    type RoleMiningRoleType (string)

    Possible values: [SPECIALIZED, COMMON]

    Role mining potential type

    state RoleMiningSessionState (string)

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

    Role mining session state

    scopingMethod RoleMiningSessionScopingMethod (string)

    Possible values: [MANUAL, AUTO_RM]

    Scoping method used in current role mining session

    type RoleMiningRoleType (string)

    Possible values: [SPECIALIZED, COMMON]

    Role mining potential type.

    id string

    Id of the potential role

    createdDate date-time

    The date-time when this potential role was created.

    modifiedDate date-time

    The date-time when this potential role was modified.

Loading...