dev.cartridge.claims.setupAdmin Documentation (EN)

main procedure

Bootstrap the claims admin space or add a member to it. Creates the admin space on first call; subsequent calls can add new admin DIDs.

Input

Encodingapplication/json

adminDid stringdid Optional

DID to add as admin. Omit on first call to just create the space.

Output

Encodingapplication/json

created boolean Optional

True if the admin space was created by this call

memberAdded boolean Optional

True if adminDid was added as a member

spaceUri stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

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",
      "properties": {
        "adminDid": {
          "type": "string",
          "format": "did",
          "description": "DID to add as admin. Omit on first call to just create the space."
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "spaceUri"
      ],
      "properties": {
        "created": {
          "type": "boolean",
          "description": "True if the admin space was created by this call"
        },
        "spaceUri": {
          "type": "string",
          "format": "at-uri"
        },
        "memberAdded": {
          "type": "boolean",
          "description": "True if adminDid was added as a member"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Bootstrap the claims admin space or add a member to it. Creates the admin space on first call; subsequent calls can add new admin DIDs."
}