Lexicon Garden

social.colibri.beta.community.registerCredentials

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.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · procedure
Kindprocedure
Authoritycommunity.beta.colibri.social
Indexed
Compare Edit in builder → Fork →
cid bafyreigdi7vd7ob5ygzlh7ap4ui7bnw75msp363zoewg7e3qc5t6ej3eqm

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.identifierNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.input.schema.properties.passwordNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "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.",
      "errors": [
        {
          "description": "The request is missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "The requesting user lacks permission to register credentials for this community.",
          "name": "Forbidden"
        },
        {
          "description": "The arguments are inconsistent or malformed beyond schema validation.",
          "name": "InvalidRequest"
        },
        {
          "description": "The PDS refused the identifier and password.",
          "name": "CredentialsRejected"
        },
        {
          "description": "A PDS or third-party call the AppView depends on failed.",
          "name": "UpstreamFailure"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "community": {
              "description": "The community the credentials belong to.",
              "format": "did",
              "type": "string"
            },
            "identifier": {
              "description": "The identifier used to authenticate with the community's PDS, such as its handle or DID.",
              "type": "string"
            },
            "password": {
              "description": "The password or app password used to authenticate with the community's PDS.",
              "type": "string"
            }
          },
          "required": [
            "community",
            "identifier",
            "password"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {},
          "required": [],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "social.colibri.beta.community.registerCredentials",
  "lexicon": 1
}