Search documentation
karat

+

K

User Documentation ↗
Version 2.0

List Available Roles Organization

GET/api/v2/admin/organizations/{organizationRid}/listAvailableRoles
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

List all roles that can be assigned to a principal 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

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

ListAvailableOrganizationRolesResponse
object
Hide child attributes

Hide child attributes

data
list<Role>
optional
Show child attributes

Show child attributes

Examples

Request

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

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 { "data": [ { "roleSetId": "3181190f-f6b8-4649-90ec-64fa2d847204", "operations": [ "compass:read-resource" ], "id": "8bf49052-dc37-4528-8bf0-b551cfb71268", "type": "ORGANIZATION" } ] }

Error responses

Error Name
ListAvailableRolesOrganizationPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not listAvailableRoles the Organization.
ParametersorganizationRid
OrganizationNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Organization could not be found.
ParametersorganizationRid