Lexicon Garden

fyi.opensocial.listRecoveryKeys

The rotation keys on the group's did:plc that matter: stewards' recovery keys and this host's own, highest priority first. A recovery key outranks the host's, so its holder can undo what the host does to the identity and move the group without it. Requires group.configure.

Repository @lexicons.opensocial.fyi did:plc:2gqnilpksz2e7faj3bwvo6qc namespace authority
Details · query
Kindquery
Authorityopensocial.fyi
Indexed
Compare Edit in builder → Fork →
cid bafyreih523n7ngqzmj6mcek74akgjaor4b2gjtqe6y74fqn6jkdk6op4h4

Checks

Valid
  • unlimited-string defs.key.properties.holderNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.key.properties.keyNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "key": {
      "properties": {
        "addedAt": {
          "format": "datetime",
          "type": "string"
        },
        "addedBy": {
          "format": "did",
          "type": "string"
        },
        "holder": {
          "knownValues": [
            "host",
            "steward"
          ],
          "type": "string"
        },
        "key": {
          "type": "string"
        }
      },
      "required": [
        "key",
        "holder"
      ],
      "type": "object"
    },
    "main": {
      "description": "The rotation keys on the group's did:plc that matter: stewards' recovery keys and this host's own, highest priority first. A recovery key outranks the host's, so its holder can undo what the host does to the identity and move the group without it. Requires group.configure.",
      "errors": [
        {
          "name": "NotController"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "hostHolds": {
              "description": "Whether this host still holds a rotation key, and so can change them.",
              "type": "boolean"
            },
            "keys": {
              "items": {
                "ref": "#key",
                "type": "ref"
              },
              "type": "array"
            },
            "max": {
              "description": "How many recovery keys a group can have.",
              "type": "integer"
            }
          },
          "required": [
            "keys",
            "hostHolds",
            "max"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "group": {
            "description": "The group DID. Every method is served by the group's host and authorized against that group's roles.",
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "group"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.listRecoveryKeys",
  "lexicon": 1
}