API v1 ReferenceRoles

Returns the role with the specified id.

<Check title="Required Permissions">The user must be an admin or have `workspace-manage-config:read` permissions.</Check>

Path parameters

roleIdstringRequiredformat: "uuid"
The id of the role.

Headers

AuthorizationstringRequired

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

Response

OK
namestring>=1 character
The name of the role. Must be unique.
isAdminRoleboolean or null
Whether this is the admin role. Only one role can be the admin role.
isGuestRoleboolean or null
Whether this is the guest role. Only one role can be the guest role.
idstring or nullformat: "uuid"
The id of the role.
isPresetboolean or null
Whether this role is one of the preset roles. Preset roles can be edited, archived and deleted.
isArchivedboolean or null
Whether the role has been archived.
createdBystring or nullformat: "uuid"
The id of the user who created this role.
createdOnstring or nullformat: "date-time"
The date this role was created.
updatedBystring or nullformat: "uuid"
The id of the user who updated this role.
updatedOnstring or nullformat: "date-time"
The date this role was last modified.