zone.stratos.admin.setActive Documentation (EN)

main procedure

Activate or deactivate an enrolled member. Requires admin authorization. Deactivation is reversible and preserves the member's boundaries.

Input

Encodingapplication/json

active boolean Required

Whether the member's enrollment should be active.

did stringdid Required

The member to update.

Output

Encodingapplication/json

active boolean Required

No description available.

did stringdid Required

A decentralized identifier (DID).

Errors

NotFound The DID is not enrolled.

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

{
  "description": "Activate or deactivate an enrolled member. Requires admin authorization. Deactivation is reversible and preserves the member's boundaries.",
  "errors": [
    {
      "description": "The DID is not enrolled.",
      "name": "NotFound"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "active": {
          "description": "Whether the member's enrollment should be active.",
          "type": "boolean"
        },
        "did": {
          "description": "The member to update.",
          "format": "did",
          "type": "string"
        }
      },
      "required": [
        "did",
        "active"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "active": {
          "type": "boolean"
        },
        "did": {
          "format": "did",
          "type": "string"
        }
      },
      "required": [
        "did",
        "active"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}