social.colibri.beta.community.registerCredentials Documentation (EN)

main procedure

Hands the AppView credentials for a community hosted elsewhere, so it can administer a community it did not create. The password is stored encrypted at rest.

Input

Encodingapplication/json

community stringdid Required

The community the credentials belong to.

identifier string Required

The identifier used to authenticate with the community's PDS, such as its handle or DID.

password string Required

The password or app password used to authenticate with the community's PDS.

Output

Encodingapplication/json

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.

Forbidden The requesting user lacks permission to register credentials for this community.

InvalidRequest The arguments are inconsistent or malformed beyond schema validation.

CredentialsRejected The PDS refused the identifier and password.

UpstreamFailure A PDS or third-party call the AppView depends on failed.

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": [
        "community",
        "identifier",
        "password"
      ],
      "properties": {
        "password": {
          "type": "string",
          "description": "The password or app password used to authenticate with the community's PDS."
        },
        "community": {
          "type": "string",
          "format": "did",
          "description": "The community the credentials belong to."
        },
        "identifier": {
          "type": "string",
          "description": "The identifier used to authenticate with the community's PDS, such as its handle or DID."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request is missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The requesting user lacks permission to register credentials for this community."
    },
    {
      "name": "InvalidRequest",
      "description": "The arguments are inconsistent or malformed beyond schema validation."
    },
    {
      "name": "CredentialsRejected",
      "description": "The PDS refused the identifier and password."
    },
    {
      "name": "UpstreamFailure",
      "description": "A PDS or third-party call the AppView depends on failed."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [],
      "properties": {}
    },
    "encoding": "application/json"
  },
  "description": "Hands the AppView credentials for a community hosted elsewhere, so it can administer a community it did not create. The password is stored encrypted at rest."
}