Skip to main content

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

POST 

https://sailpoint.api.identitynow.com/beta/role-mining-sessions/:sessionId/potential-roles/:potentialRoleId/export-async

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

Body

    minEntitlementPopularityinteger

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

    Example: 0
    includeCommonAccessboolean

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

    Example: true

Responses

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

Schema
    minEntitlementPopularityinteger

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

    Example: 0
    includeCommonAccessboolean

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

    Example: true
    exportIduuid

    ID used to reference this export

    Example: 0c6cdb76-1227-4aaf-af21-192dbdfbfa04
    statusstring

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

Authorization: oauth2

type: Personal Access Token
scopes: sp:scopes:all

Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/beta
Auth
Parameters
— pathrequired
— pathrequired
Body
{
  "minEntitlementPopularity": 0,
  "includeCommonAccess": true
}
ResponseClear

Click the Send API Request button above and see the response here!