Get a custom role

Get details about a custom role.

Path parameters

organizationIdstringRequired
The ID of the Organization to which the role belongs.
roleIdstringRequired
The role's ID.

Headers

AuthorizationstringRequired

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

Response

OK
createdAtstring
The time the role was created.
createdByobject
idstring
The role's ID.
namestring
The role's name.
permissionslist of strings
The role's permissions.
restrictedWorkspaceIdslist of strings
The IDs of Workspaces that the role is restricted to.
scopeTypeenum
The role's scope.
Allowed values:
updatedAtstring
The time the role was last updated.
updatedByobject
descriptionstring or null
The role's description.

Errors