{ "id": "licenseApiGuard", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [ { "parentPluginId": "licenseApiGuard", "id": "def-server.License", "type": "Class", "tags": [], "label": "License", "description": [], "path": "x-pack/plugins/license_api_guard/server/license.ts", "deprecated": false, "children": [ { "parentPluginId": "licenseApiGuard", "id": "def-server.License.setup", "type": "Function", "tags": [], "label": "setup", "description": [], "signature": [ "({ pluginName, logger }: SetupSettings) => void" ], "path": "x-pack/plugins/license_api_guard/server/license.ts", "deprecated": false, "children": [ { "parentPluginId": "licenseApiGuard", "id": "def-server.License.setup.$1", "type": "Object", "tags": [], "label": "{ pluginName, logger }", "description": [], "signature": [ "SetupSettings" ], "path": "x-pack/plugins/license_api_guard/server/license.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "licenseApiGuard", "id": "def-server.License.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "({ pluginId, minimumLicenseType, licensing }: StartSettings) => void" ], "path": "x-pack/plugins/license_api_guard/server/license.ts", "deprecated": false, "children": [ { "parentPluginId": "licenseApiGuard", "id": "def-server.License.start.$1", "type": "Object", "tags": [], "label": "{ pluginId, minimumLicenseType, licensing }", "description": [], "signature": [ "StartSettings" ], "path": "x-pack/plugins/license_api_guard/server/license.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "licenseApiGuard", "id": "def-server.License.guardApiRoute", "type": "Function", "tags": [], "label": "guardApiRoute", "description": [], "signature": [ "(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }>) => (ctx: Context, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, " | Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.IKibanaResponse", "text": "IKibanaResponse" }, ">" ], "path": "x-pack/plugins/license_api_guard/server/license.ts", "deprecated": false, "children": [ { "parentPluginId": "licenseApiGuard", "id": "def-server.License.guardApiRoute.$1", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RequestHandler", "text": "RequestHandler" }, " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, ") => ", "KibanaResponse", "; badRequest: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; unauthorized: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; forbidden: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; notFound: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, ") => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; customError: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.CustomHttpResponseOptions", "text": "CustomHttpResponseOptions" }, "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">) => ", "KibanaResponse", "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.ResponseError", "text": "ResponseError" }, ">; redirected: (options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; ok: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; accepted: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", " | Buffer | ", "Stream", ">; noContent: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", "section": "def-server.HttpResponseOptions", "text": "HttpResponseOptions" }, ") => ", "KibanaResponse", "; }>" ], "path": "x-pack/plugins/license_api_guard/server/license.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "licenseApiGuard", "id": "def-server.License.isEsSecurityEnabled", "type": "boolean", "tags": [], "label": "isEsSecurityEnabled", "description": [], "path": "x-pack/plugins/license_api_guard/server/license.ts", "deprecated": false } ], "initialIsOpen": false } ], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }