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.
isArchivedbooleanRequired
Flags the entity as archived.

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.
createdOndatetime or null
The date this role was created.
updatedBystring or nullformat: "uuid"
The id of the user who updated this role.
updatedOndatetime or null
The date this role was last modified.

Errors