pub.chive.governance.revokeRole Documentation (EN)

main procedure

Revoke a user's governance role. Only accessible to administrators. Also revokes any active delegation.

Input

Encodingapplication/json

did stringdid Required

DID of the user whose role to revoke

reason string Required

Reason for revoking the role

maxLength: 1000 bytesminLength: 10 bytes

Output

Encodingapplication/json

Schema#elevationResult

Errors

AuthenticationRequired

Unauthorized

InvalidRequest

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "did",
        "reason"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "DID of the user whose role to revoke"
        },
        "reason": {
          "type": "string",
          "maxLength": 1000,
          "minLength": 10,
          "description": "Reason for revoking the role"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "Unauthorized"
    },
    {
      "name": "InvalidRequest"
    }
  ],
  "output": {
    "schema": {
      "ref": "#elevationResult",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "description": "Revoke a user's governance role. Only accessible to administrators. Also revokes any active delegation."
}

elevationResult object

Result of role operation

Properties

message string Required

Human-readable result message

requestId string Optional

Request ID (if applicable)

success boolean Required

Whether the operation succeeded

View raw schema

{
  "type": "object",
  "required": [
    "success",
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "description": "Human-readable result message"
    },
    "success": {
      "type": "boolean",
      "description": "Whether the operation succeeded"
    },
    "requestId": {
      "type": "string",
      "description": "Request ID (if applicable)"
    }
  },
  "description": "Result of role operation"
}