Skip to main content

List Role Assignments

Request

Get a page of all the RoleAssignments for the given assignment scope.

The auth token's access policy must allow action:use/listRoleAssignments.

Security
bearerAuth
Query
pageTokenstring, [ 1 .. 4096 ] characters(PageToken)

Opaque token identifying the page of results to retrieve.

Example:pageToken=eyJwYWdlIjoyfQ==
pageSizeinteger, [ 1 .. 1000 ](PageSize)

Maximum number of results to return per page.

Default:100
Example:pageSize=20
assignmentScopeIdstringrequired

Id of the object this assignment scope refers to

Example:assignmentScopeId=07218c48-343d-43e2-9831-a2080445cd22
assignmentScopeTypestringrequired

Type of object that defines the scope of a role assignment (e.g. PROJECT, ORGANIZATION).

Example:assignmentScopeType=PROJECT
Payload
// No request payload

Responses

Success

Bodyapplication/json
listArray of objects(RoleAssignment)required
nextPageTokenstring, [ 1 .. 4096 ] characters(NextPageToken)

When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous call.

Example:"eyJsYXN0S2V5IjoiYWJjMTIzIn0="
Response
{ "list": [ { … } ], "nextPageToken": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" }
Was this page helpful?