Skip to main content

List roles

GET 
/roles/v2
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 API returns a list of Roles. Each Role includes its effective privilege level in privilegeLevel.effective, which is the highest effective privilege level among the entitlements assigned directly to the Role and the entitlements included in the Role's access profiles.

Use either offset pagination (offset and limit) or cursor pagination (cursor and limit). When more results are available, the x-next-cursor response header contains the cursor for the next page. Send that value in the cursor query parameter, with the same sorters, to get the next page. You can't use cursor together with an offset greater than 0, and offset plus limit can't be greater than 10,000. Use cursor pagination to page beyond 10,000 results.

A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.

Request​

Responses​

List of Roles

Response Headers
    x-total-count

    The total result count (returned only if the count parameter is specified as true).

    Example: 75
    x-next-cursor

    Opaque cursor for the next page of results. Returned only when more results are available. Pass it in the cursor query parameter to get the next page.

    Example: eyJzb3J0IjpbIm5hbWUiLCJpZCJdLCJzZWFyY2hBZnRlciI6WyJSb2xlIDI1NjciLCIyYzkxIl19