Request all system rescue key pairs

v1.0.0

🚀 Since v4.24.0

Description:

Retrieve all system rescue key pairs to allow migrating system-rescue-key-encrypted file keys.

Precondition:

Right 🔓 change config
Existence of own key pair

Postcondition:

List of key pairs is returned.

Further Information:

In the case of an algorithm migration of a system rescue key, one should create the new key pair before deleting the old one.
This allows re-encrypting file keys with the new key pair, using the old one.

This API allows to retrieve both key pairs, in contrast to GET /settings/keypair, which only delivers the preferred one.

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    },
    "X-Sds-Date-Format": {
      "type": "string",
      "enum": [
        "UTC",
        "LOCAL",
        "OFFSET",
        "EPOCH",
        "LEET"
      ]
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "description": "Key pair container",
    "required": [
      "privateKeyContainer",
      "publicKeyContainer"
    ],
    "properties": {
      "privateKeyContainer": {
        "type": "object",
        "description": "Private key container",
        "required": [
          "privateKey",
          "version"
        ],
        "properties": {
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "&#128640; Since v4.24.0\n\nCreation date"
          },
          "createdBy": {
            "type": "integer",
            "format": "int64",
            "description": "&#128640; Since v4.24.0\n\nCreated by user"
          },
          "privateKey": {
            "type": "string",
            "description": "Private key"
          },
          "version": {
            "type": "string",
            "description": "Version"
          }
        }
      },
      "publicKeyContainer": {
        "type": "object",
        "description": "Public key container",
        "required": [
          "publicKey",
          "version"
        ],
        "properties": {
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "&#128640; Since v4.24.0\n\nCreation date"
          },
          "createdBy": {
            "type": "integer",
            "format": "int64",
            "description": "&#128640; Since v4.24.0\n\nCreated by user"
          },
          "publicKey": {
            "type": "string",
            "description": "Public key"
          },
          "version": {
            "type": "string",
            "description": "Version"
          }
        }
      }
    }
  }
}