Get a list of roles

Returns a paginated list of roles. Scope the results with either resourceId (roles of a single resource) or integrationId (every role across all resources of an integration, in one paginated response — use this to avoid issuing one request per resource). At least one of the two is required; if both are provided, resourceId takes precedence. Optionally filter by externalId or search.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
≥ 1
Defaults to 1
number
1 to 100
Defaults to 100
string

Search roles by name. Exact matches are ranked first, followed by case-insensitive and partial matches.

string

Filter roles by external identifier (the ID given by the third-party app, e.g. AWS, GitHub).

uuid

Unique identifier for the resource. Provide either resourceId or integrationId. To get resource IDs, use GET /public/v1/resources?integrationId=.

uuid

Filter roles by integration. Returns every role across all resources in the integration in a single paginated response. Provide either resourceId or integrationId. To get integration IDs, use GET /public/v1/integrations.

Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.