Get a custom role

GET

Get details about a custom role.

Path parameters

organizationIdstringRequired

The ID of the Organization to which the role belongs.

roleIdstringRequired

The role’s ID.

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
Allowed values: DEPLOYMENTWORKSPACEORGANIZATION

The role’s scope.

updatedAtstring

The time the role was last updated.

updatedByobject
descriptionstringOptional

The role’s description.

Built with