Search documentation
karat

+

K

User Documentation ↗
Version 2.0

List Organization Role Assignments

GET/api/v2/admin/organizations/{organizationRid}/roleAssignments

List all principals who are assigned a role for the given Organization.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.

Path parameters

organizationRid
string

Response body

ListOrganizationRoleAssignmentsResponse
object
Hide child attributes

Hide child attributes

data
list<OrganizationRoleAssignment>
optional
Show child attributes

Show child attributes

nextPageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/organizations/ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa/roleAssignments"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 { "data": [ { "roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "principalType": "USER" } ], "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z" }

Error responses

Error Name
ListOrganizationRoleAssignmentsPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionThe provided token does not have permission to list assigned roles for this organization.
ParametersorganizationRid
OrganizationNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Organization could not be found.
ParametersorganizationRid