rip.pds.account.createAccount

pds.rip

Documentation

Mint an ephemeral account owned by the calling account. The account is deleted and its identity retired when it expires.

main procedure

Mint an ephemeral account owned by the calling account. The account is deleted and its identity retired when it expires.

Input

Encodingapplication/json
domain string Optional

Handle domain to mint under, which also selects the identity method. Defaults to the server's first configured domain.

handle stringhandle Optional

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

password string Optional

Password for the new account. One is generated and returned when omitted.

maxLength: 256 bytesminLength: 8 bytes

Output

Encodingapplication/json
password string Required

Shown once. The server does not store it in a recoverable form.

pdsEndpoint stringuri Required

A valid URI.

Errors

QuotaExceeded The caller already holds the maximum number of live accounts.
HandleUnavailable The requested handle is taken or not valid for the domain.
UnknownDomain The requested domain is not offered by this server.
OwnerNotEligible The caller's own identity is hosted here and would expire, orphaning what it mints.
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, which also selects the identity method. Defaults to the server's first configured domain."
        },
        "handle": {
          "type": "string",
          "format": "handle",
          "description": "Desired handle. A two-word handle under the chosen domain is generated when omitted."
        },
        "password": {
          "type": "string",
          "maxLength": 256,
          "minLength": 8,
          "description": "Password for the new account. One is generated and returned when omitted."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "QuotaExceeded",
      "description": "The caller already holds the maximum number of live accounts."
    },
    {
      "name": "HandleUnavailable",
      "description": "The requested handle is taken or not valid for the domain."
    },
    {
      "name": "UnknownDomain",
      "description": "The requested domain is not offered by this server."
    },
    {
      "name": "OwnerNotEligible",
      "description": "The caller's own identity is hosted here and would expire, orphaning what it mints."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "account",
        "password",
        "pdsEndpoint"
      ],
      "properties": {
        "account": {
          "ref": "rip.pds.account.defs#accountView",
          "type": "ref"
        },
        "password": {
          "type": "string",
          "description": "Shown once. The server does not store it in a recoverable form."
        },
        "pdsEndpoint": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Mint an ephemeral account owned by the calling account. The account is deleted and its identity retired when it expires."
}

Lexicon Garden

@