Skip to main content

Asynchronously export details for a potential role in a role mining session and upload to S3

POST 

/role-mining-sessions/:sessionId/potential-roles/:potentialRoleId/export-async

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 endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role.

Request

Path Parameters

    sessionId stringrequired

    The role mining session id

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

    A potential role id in a role mining session

    Example: 278359a6-04b7-4669-9468-924cf580964a

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Body

    minEntitlementPopularity integer

    The minimum popularity among identities in the role which an entitlement must have to be included in the report

    includeCommonAccess boolean

    If false, do not include entitlements that are highly popular among the entire orginization

Responses

Job Submitted. Returns a reportId that can be used to download the zip once complete

Schema

    minEntitlementPopularity integer

    The minimum popularity among identities in the role which an entitlement must have to be included in the report

    includeCommonAccess boolean

    If false, do not include entitlements that are highly popular among the entire orginization

    exportId uuid

    ID used to reference this export

    status RoleMiningPotentialRoleExportState (string)

    Possible values: [QUEUED, IN_PROGRESS, SUCCESS, ERROR]

    The status of this export

Loading...