pub.chive.admin.assignRole Documentation (EN)

main procedure

Assign a role to a user

Input

Encodingapplication/json

did stringdid Required

Target user DID

role string Required

Role to assign

Output

Encodingapplication/json

success boolean Required

Whether the role was assigned

Errors

AuthenticationRequired

AdminRequired

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",
        "role"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "Target user DID"
        },
        "role": {
          "type": "string",
          "description": "Role to assign",
          "knownValues": [
            "admin",
            "moderator",
            "graph-editor",
            "author",
            "reader",
            "alpha-tester",
            "premium"
          ]
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AdminRequired"
    },
    {
      "name": "InvalidRequest"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "success"
      ],
      "properties": {
        "success": {
          "type": "boolean",
          "description": "Whether the role was assigned"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Assign a role to a user"
}