API v1 ReferenceRoles

Returns all roles of the workspace.

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

Authentication

AuthorizationBearer

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

Query parameters

showArchivedbooleanOptionalDefaults to false
Whether to show archived roles.

Response

OK
namestring>=1 character
The name of the role. Must be unique.
isAdminRoleboolean
Whether this is the admin role. Only one role can be the admin role.
isGuestRoleboolean
Whether this is the guest role. Only one role can be the guest role.
idstringformat: "uuid"
The id of the role.
isPresetboolean
Whether this role is one of the preset roles. Preset roles can be edited, archived and deleted.
isArchivedboolean
Whether the role has been archived.
createdBystringformat: "uuid"
The id of the user who created this role.
createdOndatetime
The date this role was created.
updatedBystringformat: "uuid"
The id of the user who updated this role.
updatedOndatetime
The date this role was last modified.