fyi.opensocial.listRecoveryKeys

lexicons.opensocial.fyi

Documentation

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.

main query

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.

Parameters

group string did Required

The group DID. Every method is served by the group's host and authorized against that group's roles.

Output

Encodingapplication/json
hostHolds boolean Required

Whether this host still holds a rotation key, and so can change them.

keys array Required

No description available.

max integer Required

How many recovery keys a group can have.

Errors

NotPlc
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://api.bsky.social)
Parameters
The group DID. Every method is served by the group's host and authorized against that group's roles.
View raw schema 
{
  "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": "NotPlc"
    }
  ],
  "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"
}
key object

No description available.

Properties

addedAt string datetime Optional

An RFC 3339 formatted timestamp.

addedBy string did Optional

A decentralized identifier (DID).

holder string Required

No description available.

Known values: host, steward
key string Required

No description available.

View raw schema 
{
  "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"
}

Lexicon Garden

@