# fyi.opensocial.listRecoveryKeys

> Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listRecoveryKeys)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listRecoveryKeys/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.listRecoveryKeys/examples)

## Definitions

### `fyi.opensocial.listRecoveryKeys#key`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `addedAt` | `string` (datetime) | No |  |
| `addedBy` | `string` (did) | No |  |
| `holder` | `string` | Yes |  |
| `key` | `string` | Yes |  |

### `fyi.opensocial.listRecoveryKeys`

**Type**: `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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `group` | `string` (did) | Yes | The group DID. Every method is served by the group's host and authorized against that group's roles. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `hostHolds` | `boolean` | Yes | Whether this host still holds a rotation key, and so can change them. |
| `keys` | `array` | Yes |  |
| `max` | `integer` | Yes | How many recovery keys a group can have. |

#### Errors

- **NotPlc**

## Raw Schema

```json
{
  "$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": "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"
    }
  },
  "id": "fyi.opensocial.listRecoveryKeys",
  "lexicon": 1
}
```