role.archive

Archive a custom role. Builtin roles and roles still assigned to an operator cannot be archived.

• Scope: iam.roles.write
• System: no
• Reachable from: POST /v1/commands/role.archive (tenant credential) · MCP tool role.archive · SDK client.call('role.archive', …)
• Events: role.archived

Input (JSON Schema)

{
  "properties": {
    "key": {
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "key"
  ],
  "type": "object"
}

Result (200)

{
  "additionalProperties": false,
  "properties": {
    "archived": {
      "type": "boolean"
    },
    "role_id": {
      "type": "string"
    }
  },
  "required": [
    "role_id",
    "archived"
  ],
  "type": "object"
}

Errors

validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)