API v1 ReferenceRoles

Archives or unarchives the role with the specified id.

Archives or unarchives the role with the specified id. An archived role still exists for all users currently using it, but users can no longer be assigned to this role. <Check title="Required Permissions" icon="key">The user must be an admin or have `task-manage-config:write` 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.

Request

The archived form payload.
isArchivedbooleanOptional
Flags the entity as archived.

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.

Errors

400
Bad Request Error
404
Not Found Error