{ "id": "encryptedSavedObjects", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [ { "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" ], "children": [ { "id": "def-server.EncryptionError.Unnamed", "type": "Function", "label": "Constructor", "signature": [ "any" ], "description": [], "children": [ { "type": "string", "label": "message", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 18 } }, { "type": "string", "label": "attributeName", "isRequired": true, "signature": [ "string" ], "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 19 } }, { "type": "Enum", "label": "operation", "isRequired": true, "signature": [ { "pluginId": "encryptedSavedObjects", "scope": "server", "docId": "kibEncryptedSavedObjectsPluginApi", "section": "def-server.EncryptionErrorOperation", "text": "EncryptionErrorOperation" } ], "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 20 } }, { "type": "Object", "label": "cause", "isRequired": false, "signature": [ "Error | undefined" ], "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 21 } } ], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 17 } }, { "id": "def-server.EncryptionError.toJSON", "type": "Function", "label": "toJSON", "signature": [ "() => { message: string; }" ], "description": [], "children": [], "tags": [], "returnComment": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 30 } } ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts", "lineNumber": 16 }, "initialIsOpen": false } ], "functions": [], "interfaces": [ { "id": "def-server.EncryptedSavedObjectsClient", "type": "Interface", "label": "EncryptedSavedObjectsClient", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser", "type": "Function", "label": "getDecryptedAsInternalUser", "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", "lineNumber": 41 }, "signature": [ "(type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", "section": "def-server.SavedObjectsBaseOptions", "text": "SavedObjectsBaseOptions" }, " | undefined) => Promise<", { "pluginId": "core", "scope": "common", "docId": "kibCorePluginApi", "section": "def-common.SavedObject", "text": "SavedObject" }, ">" ] } ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", "lineNumber": 40 }, "initialIsOpen": false }, { "id": "def-server.EncryptedSavedObjectTypeRegistration", "type": "Interface", "label": "EncryptedSavedObjectTypeRegistration", "description": [ "\nDescribes the registration entry for the saved object type that contain attributes that need to\nbe encrypted." ], "tags": [], "children": [ { "tags": [], "id": "def-server.EncryptedSavedObjectTypeRegistration.type", "type": "string", "label": "type", "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", "lineNumber": 34 } }, { "tags": [], "id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToEncrypt", "type": "Object", "label": "attributesToEncrypt", "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", "lineNumber": 35 }, "signature": [ "ReadonlySet" ] }, { "tags": [], "id": "def-server.EncryptedSavedObjectTypeRegistration.attributesToExcludeFromAAD", "type": "Object", "label": "attributesToExcludeFromAAD", "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", "lineNumber": 36 }, "signature": [ "ReadonlySet | undefined" ] } ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts", "lineNumber": 33 }, "initialIsOpen": false } ], "enums": [], "misc": [], "objects": [], "setup": { "id": "def-server.EncryptedSavedObjectsPluginSetup", "type": "Interface", "label": "EncryptedSavedObjectsPluginSetup", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.EncryptedSavedObjectsPluginSetup.canEncrypt", "type": "boolean", "label": "canEncrypt", "description": [ "\nIndicates if Saved Object encryption is possible. Requires an encryption key to be explicitly set via `xpack.encryptedSavedObjects.encryptionKey`." ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 35 } }, { "tags": [], "id": "def-server.EncryptedSavedObjectsPluginSetup.registerType", "type": "Function", "label": "registerType", "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 36 }, "signature": [ "(typeRegistration: ", { "pluginId": "encryptedSavedObjects", "scope": "server", "docId": "kibEncryptedSavedObjectsPluginApi", "section": "def-server.EncryptedSavedObjectTypeRegistration", "text": "EncryptedSavedObjectTypeRegistration" }, ") => void" ] }, { "tags": [], "id": "def-server.EncryptedSavedObjectsPluginSetup.createMigration", "type": "Function", "label": "createMigration", "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 37 }, "signature": [ { "pluginId": "encryptedSavedObjects", "scope": "server", "docId": "kibEncryptedSavedObjectsPluginApi", "section": "def-server.CreateEncryptedSavedObjectsMigrationFn", "text": "CreateEncryptedSavedObjectsMigrationFn" } ] } ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 31 }, "lifecycle": "setup", "initialIsOpen": true }, "start": { "id": "def-server.EncryptedSavedObjectsPluginStart", "type": "Interface", "label": "EncryptedSavedObjectsPluginStart", "description": [], "tags": [], "children": [ { "tags": [], "id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError", "type": "Function", "label": "isEncryptionError", "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 41 }, "signature": [ "(error: Error) => boolean" ] }, { "tags": [], "id": "def-server.EncryptedSavedObjectsPluginStart.getClient", "type": "Function", "label": "getClient", "description": [], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 42 }, "signature": [ { "pluginId": "encryptedSavedObjects", "scope": "server", "docId": "kibEncryptedSavedObjectsPluginApi", "section": "def-server.ClientInstanciator", "text": "ClientInstanciator" } ] } ], "source": { "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "lineNumber": 40 }, "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }