Skip to main content

Filter roles by metadata

POST 
/roles/v2/filter
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 filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together. Each Role includes its effective privilege level in privilegeLevel.effective.

The filters expression in the request body supports the same fields and operators as the filters query parameter of List roles, including privilegeLevel.effective: eq, in.

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 request body and 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.

Request​

Responses​

List of Roles matching the filter criteria.

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