kibana/api_docs/encrypted_saved_objects.json

{
  "id": "encryptedSavedObjects",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [
      {
        "parentPluginId": "encryptedSavedObjects",
        "id": "def-server.EncryptionError",
        "type": "Class",
        "tags": [],
        "label": "EncryptionError",
        "description": [],
        "signature": [
          {
            "pluginId": "encryptedSavedObjects",
            "scope": "server",
            "docId": "kibEncryptedSavedObjectsPluginApi",
            "section": "def-server.EncryptionError",
            "text": "EncryptionError"
          },
          " extends Error"
        ],
        "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "encryptedSavedObjects",
            "id": "def-server.EncryptionError.Unnamed",
            "type": "Function",
            "tags": [],
            "label": "Constructor",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "encryptedSavedObjects",
                "id": "def-server.EncryptionError.Unnamed.$1",
                "type": "string",
                "tags": [],
                "label": "message",
                "description": [],
                "signature": [
                  "string"
                ],
                "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
                "deprecated": false,
                "isRequired": true
              },
              {
                "parentPluginId": "encryptedSavedObjects",
                "id": "def-server.EncryptionError.Unnamed.$2",
                "type": "string",
                "tags": [],
                "label": "attributeName",
                "description": [],
                "signature": [
                  "string"
                ],
                "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
                "deprecated": false,
                "isRequired": true
              },
              {
                "parentPluginId": "encryptedSavedObjects",
                "id": "def-server.EncryptionError.Unnamed.$3",
                "type": "Enum",
                "tags": [],
                "label": "operation",
                "description": [],
                "signature": [
                  "EncryptionErrorOperation"
                ],
                "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
                "deprecated": false,
                "isRequired": true
              },
              {
                "parentPluginId": "encryptedSavedObjects",
                "id": "def-server.EncryptionError.Unnamed.$4",
                "type": "Object",
                "tags": [],
                "label": "cause",
                "description": [],
                "signature": [
                  "Error | undefined"
                ],
                "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
                "deprecated": false,
                "isRequired": false
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "encryptedSavedObjects",
            "id": "def-server.EncryptionError.toJSON",
            "type": "Function",
            "tags": [],
            "label": "toJSON",
            "description": [],
            "signature": [
              "() => { message: string; }"
            ],
            "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts",
            "deprecated": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "encryptedSavedObjects",
        "id": "def-server.EncryptedSavedObjectsClient",
        "type": "Interface",
        "tags": [],
        "label": "EncryptedSavedObjectsClient",
        "description": [],
        "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "encryptedSavedObjects",
            "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser",
            "type": "Function",
            "tags": [],
            "label": "getDecryptedAsInternalUser",
            "description": [],
            "signature": [
              "<T = unknown>(type: string, id: string, options?: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCoreSavedObjectsPluginApi",
                "section": "def-server.SavedObjectsBaseOptions",
                "text": "SavedObjectsBaseOptions"
              },
              " | undefined) => Promise<",
              "SavedObject",
              "<T>>"
            ],
            "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "encryptedSavedObjects",
                "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$1",
                "type": "string",
                "tags": [],
                "label": "type",
                "description": [],
                "signature": [
                  "string"
                ],
                "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
                "deprecated": false,
                "isRequired": true
              },
              {
                "parentPluginId": "encryptedSavedObjects",
                "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$2",
                "type": "string",
                "tags": [],
                "label": "id",
                "description": [],
                "signature": [
                  "string"
                ],
                "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
                "deprecated": false,
                "isRequired": true
              },
              {
                "parentPluginId": "encryptedSavedObjects",
                "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$3",
                "type": "Object",
                "tags": [],
                "label": "options",
                "description": [],
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCoreSavedObjectsPluginApi",
                    "section": "def-server.SavedObjectsBaseOptions",
                    "text": "SavedObjectsBaseOptions"
                  },
                  " | undefined"
                ],
                "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
                "deprecated": false,
                "isRequired": false
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "encryptedSavedObjects",
        "id": "def-server.EncryptedSavedObjectTypeRegistration",
        "type": "Interface",
        "tags": [],
        "label": "EncryptedSavedObjectTypeRegistration",
        "description": [
          "\nDescribes the registration entry for the saved object type that contain attributes that need to\nbe encrypted."
        ],
        "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "encryptedSavedObjects",
            "id": "def-server.EncryptedSavedObjectTypeRegistration.type",
            "type": "string",
            "tags": [],
            "label": "type",
            "description": [],
            "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "encryptedSavedObjects",
            "id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToEncrypt",
            "type": "Object",
            "tags": [],
            "label": "attributesToEncrypt",
            "description": [],
            "signature": [
              "ReadonlySet<string | ",
              "AttributeToEncrypt",
              ">"
            ],
            "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "encryptedSavedObjects",
            "id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToExcludeFromAAD",
            "type": "Object",
            "tags": [],
            "label": "attributesToExcludeFromAAD",
            "description": [],
            "signature": [
              "ReadonlySet<string> | undefined"
            ],
            "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "encryptedSavedObjects",
        "id": "def-server.IsMigrationNeededPredicate",
        "type": "Type",
        "tags": [],
        "label": "IsMigrationNeededPredicate",
        "description": [],
        "signature": [
          "(encryptedDoc: ",
          {
            "pluginId": "core",
            "scope": "server",
            "docId": "kibCoreSavedObjectsPluginApi",
            "section": "def-server.SavedObjectUnsanitizedDoc",
            "text": "SavedObjectUnsanitizedDoc"
          },
          "<InputAttributes> | ",
          {
            "pluginId": "core",
            "scope": "server",
            "docId": "kibCoreSavedObjectsPluginApi",
            "section": "def-server.SavedObjectUnsanitizedDoc",
            "text": "SavedObjectUnsanitizedDoc"
          },
          "<MigratedAttributes>) => encryptedDoc is ",
          {
            "pluginId": "core",
            "scope": "server",
            "docId": "kibCoreSavedObjectsPluginApi",
            "section": "def-server.SavedObjectUnsanitizedDoc",
            "text": "SavedObjectUnsanitizedDoc"
          },
          "<InputAttributes>"
        ],
        "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
        "deprecated": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "encryptedSavedObjects",
            "id": "def-server.IsMigrationNeededPredicate.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "encryptedDoc",
            "description": [],
            "signature": [
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCoreSavedObjectsPluginApi",
                "section": "def-server.SavedObjectUnsanitizedDoc",
                "text": "SavedObjectUnsanitizedDoc"
              },
              "<InputAttributes> | ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCoreSavedObjectsPluginApi",
                "section": "def-server.SavedObjectUnsanitizedDoc",
                "text": "SavedObjectUnsanitizedDoc"
              },
              "<MigratedAttributes>"
            ],
            "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "parentPluginId": "encryptedSavedObjects",
      "id": "def-server.EncryptedSavedObjectsPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "EncryptedSavedObjectsPluginSetup",
      "description": [],
      "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "encryptedSavedObjects",
          "id": "def-server.EncryptedSavedObjectsPluginSetup.canEncrypt",
          "type": "boolean",
          "tags": [],
          "label": "canEncrypt",
          "description": [
            "\nIndicates if Saved Object encryption is possible. Requires an encryption key to be explicitly set via `xpack.encryptedSavedObjects.encryptionKey`."
          ],
          "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "encryptedSavedObjects",
          "id": "def-server.EncryptedSavedObjectsPluginSetup.registerType",
          "type": "Function",
          "tags": [],
          "label": "registerType",
          "description": [],
          "signature": [
            "(typeRegistration: ",
            {
              "pluginId": "encryptedSavedObjects",
              "scope": "server",
              "docId": "kibEncryptedSavedObjectsPluginApi",
              "section": "def-server.EncryptedSavedObjectTypeRegistration",
              "text": "EncryptedSavedObjectTypeRegistration"
            },
            ") => void"
          ],
          "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
          "deprecated": false,
          "children": [
            {
              "parentPluginId": "encryptedSavedObjects",
              "id": "def-server.EncryptedSavedObjectsPluginSetup.registerType.$1",
              "type": "Object",
              "tags": [],
              "label": "typeRegistration",
              "description": [],
              "signature": [
                {
                  "pluginId": "encryptedSavedObjects",
                  "scope": "server",
                  "docId": "kibEncryptedSavedObjectsPluginApi",
                  "section": "def-server.EncryptedSavedObjectTypeRegistration",
                  "text": "EncryptedSavedObjectTypeRegistration"
                }
              ],
              "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
              "deprecated": false,
              "isRequired": true
            }
          ],
          "returnComment": []
        },
        {
          "parentPluginId": "encryptedSavedObjects",
          "id": "def-server.EncryptedSavedObjectsPluginSetup.createMigration",
          "type": "Function",
          "tags": [],
          "label": "createMigration",
          "description": [],
          "signature": [
            "<InputAttributes = unknown, MigratedAttributes = InputAttributes>(opts: ",
            "CreateEncryptedSavedObjectsMigrationFnOpts",
            "<InputAttributes, MigratedAttributes>) => SavedObjectOptionalMigrationFn<InputAttributes, MigratedAttributes>"
          ],
          "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
          "deprecated": false,
          "returnComment": [],
          "children": [
            {
              "parentPluginId": "encryptedSavedObjects",
              "id": "def-server.EncryptedSavedObjectsPluginSetup.createMigration.$1",
              "type": "Object",
              "tags": [],
              "label": "opts",
              "description": [],
              "signature": [
                "CreateEncryptedSavedObjectsMigrationFnOpts",
                "<InputAttributes, MigratedAttributes>"
              ],
              "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
              "deprecated": false
            }
          ]
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "encryptedSavedObjects",
      "id": "def-server.EncryptedSavedObjectsPluginStart",
      "type": "Interface",
      "tags": [],
      "label": "EncryptedSavedObjectsPluginStart",
      "description": [],
      "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "encryptedSavedObjects",
          "id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError",
          "type": "Function",
          "tags": [],
          "label": "isEncryptionError",
          "description": [],
          "signature": [
            "(error: Error) => boolean"
          ],
          "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
          "deprecated": false,
          "children": [
            {
              "parentPluginId": "encryptedSavedObjects",
              "id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError.$1",
              "type": "Object",
              "tags": [],
              "label": "error",
              "description": [],
              "signature": [
                "Error"
              ],
              "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
              "deprecated": false,
              "isRequired": true
            }
          ],
          "returnComment": []
        },
        {
          "parentPluginId": "encryptedSavedObjects",
          "id": "def-server.EncryptedSavedObjectsPluginStart.getClient",
          "type": "Function",
          "tags": [],
          "label": "getClient",
          "description": [],
          "signature": [
            "(options?: ",
            "EncryptedSavedObjectsClientOptions",
            " | undefined) => ",
            {
              "pluginId": "encryptedSavedObjects",
              "scope": "server",
              "docId": "kibEncryptedSavedObjectsPluginApi",
              "section": "def-server.EncryptedSavedObjectsClient",
              "text": "EncryptedSavedObjectsClient"
            }
          ],
          "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
          "deprecated": false,
          "returnComment": [],
          "children": [
            {
              "parentPluginId": "encryptedSavedObjects",
              "id": "def-server.EncryptedSavedObjectsPluginStart.getClient.$1",
              "type": "Object",
              "tags": [],
              "label": "options",
              "description": [],
              "signature": [
                "EncryptedSavedObjectsClientOptions",
                " | undefined"
              ],
              "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
              "deprecated": false
            }
          ]
        }
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}