Skip to main content
POST
Search App Resource Roles

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
teamId
string | null

Filter by team ID. Required if app_instance_ids is not provided.

appInstanceIds
string[]

Filter by app instance IDs.

resourceIds
string[]

Filter by resource IDs.

pageSize
integer<int32> | null

Maximum number of results to return. With query, the default is 50 and the maximum is 200. Without query, the default and maximum are 10000.

pageToken
string | null

Token for pagination. Leave empty for the first request.

query
string | null

Case-insensitive substring search over role and parent-resource names, descriptions, and external IDs. Maximum 256 characters.

Response

200 - application/json

Success

data
Role · object[]

The list of roles.

nextPageToken
string | null

Token for retrieving the next page of results. Empty if no more results.