Returns the role with the specified id.

GET
Required Permissions: The user must be an admin or have workspace-manage-config:read permissions.

Path parameters

roleIdstringRequired
The id of the role.

Response

This endpoint returns an object
namestring
The name of the role. Must be unique.
isAdminRolebooleanOptional
Whether this is the admin role. Only one role can be the admin role.
isGuestRolebooleanOptional
Whether this is the guest role. Only one role can be the guest role.
idstringOptional
The id of the role.
isPresetbooleanOptional
Whether this role is one of the preset roles. Preset roles can be edited, archived and deleted.
isArchivedbooleanOptional
Whether the role has been archived.
createdBystringOptional
The id of the user who created this role.
createdOndatetimeOptional
The date this role was created.
updatedBystringOptional
The id of the user who updated this role.
updatedOndatetimeOptional
The date this role was last modified.
Built with