API v1 ReferenceRoles

Returns the role with the specified name.

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

Path parameters

roleNamestringRequired
The name 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.
idUUID or null
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.
createdByUUID or null
The id of the user who created this role.
createdOndatetime or null
The date this role was created.
updatedByUUID or null
The id of the user who updated this role.
updatedOndatetime or null
The date this role was last modified.