Skip to main content

Retrieves all potential role summaries

GET 
/role-mining-potential-roles
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.

Returns all potential role summaries that match the query parameters

Request​

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, identityCount, entitlementCount, freshness, quality

    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, ge, gt, le, lt

    quality: eq, ge, gt, le, lt

    startDate: ge, gt

    saved: eq

    type: eq, ge, gt, le, lt

    scopingMethod: eq

    sessionState: eq

    identityAttribute: co

    Example: (createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))
    offset int32

    Default value: 0

    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

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses​

Succeeded. Returns all potential role summaries that match the query parameters.

Schema

  • Array [

    • id string

    Id of the potential role

    name string

    Name of the potential role

    potentialRoleRef

    object

    Details about the potential role

    id string

    Id of the potential role

    name string

    Name of the potential role

    identityCount int32

    The number of identities in a potential role.

    entitlementCount int32

    The number of entitlements in a potential role.

    identityGroupStatus string

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

    provisionState RoleMiningPotentialRoleProvisionState (string)

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

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

    roleId stringnullable

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

    density int32

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

    freshness int32

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

    quality int32

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

    type RoleMiningRoleType (string)

    Possible values: [SPECIALIZED, COMMON]

    Role mining potential type.

    createdBy

    object

    The potential role created by details

    oneOf

    id string

    ID of the creator

    displayName string

    The display name of the creator

    createdDate date-time

    The date-time when this potential role was created.

    saved boolean

    The potential role's saved status

    description stringnullable

    Description of the potential role

    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

  • ]

Loading...