rip.pds.admin.createAccount

pds.rip

Documentation

Issue an account on any configured domain, including operator-only and permanent ones, optionally on somebody else's behalf. Bypasses the quota. Operators only.

main procedure

Issue an account on any configured domain, including operator-only and permanent ones, optionally on somebody else's behalf. Bypasses the quota. Operators only.

Input

Encodingapplication/json
domain string Optional

Handle domain to mint under. Defaults to the server's first configured domain, which is never the operator-only one.

handle stringhandle Optional

Desired handle. A two-word handle under the chosen domain is generated when omitted.

ownerDid stringdid Optional

Who ends up holding the account, and sees it in their own dashboard. Defaults to the operator.

password string Optional

One is generated and returned when omitted.

maxLength: 256 bytesminLength: 8 bytes

Output

Encodingapplication/json
password string Required

Shown once.

pdsEndpoint stringuri Required

A valid URI.

Errors

NotAnOperator The calling account does not operate this server.
HandleUnavailable The requested handle is taken or not valid for the domain.
UnknownDomain The requested domain is not configured on this server.
Try It

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

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "description": "Handle domain to mint under. Defaults to the server's first configured domain, which is never the operator-only one."
        },
        "handle": {
          "type": "string",
          "format": "handle",
          "description": "Desired handle. A two-word handle under the chosen domain is generated when omitted."
        },
        "ownerDid": {
          "type": "string",
          "format": "did",
          "description": "Who ends up holding the account, and sees it in their own dashboard. Defaults to the operator."
        },
        "password": {
          "type": "string",
          "maxLength": 256,
          "minLength": 8,
          "description": "One is generated and returned when omitted."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "NotAnOperator",
      "description": "The calling account does not operate this server."
    },
    {
      "name": "HandleUnavailable",
      "description": "The requested handle is taken or not valid for the domain."
    },
    {
      "name": "UnknownDomain",
      "description": "The requested domain is not configured on this server."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "account",
        "password",
        "pdsEndpoint"
      ],
      "properties": {
        "account": {
          "ref": "rip.pds.admin.defs#accountView",
          "type": "ref"
        },
        "password": {
          "type": "string",
          "description": "Shown once."
        },
        "pdsEndpoint": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Issue an account on any configured domain, including operator-only and permanent ones, optionally on somebody else's behalf. Bypasses the quota. Operators only."
}

Lexicon Garden

@