API v1 ReferenceRoles

Returns the role with the specified id.

<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.

Path parameters

roleIdstringRequiredformat: "uuid"
The id of the role.

Response

OK
namestring>=1 character
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.
idstringOptionalformat: "uuid"
The id of the role.
isAgentRolebooleanOptional

Whether this is a retained role from the legacy agent-as-user model. The role cannot be modified.

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.
createdBystringOptionalformat: "uuid"
The id of the user who created this role.
createdOnstringOptionalformat: "date-time"
The date this role was created.
updatedBystringOptionalformat: "uuid"
The id of the user who updated this role.
updatedOnstringOptionalformat: "date-time"
The date this role was last modified.

Errors

404
Not Found Error