{ "id": "actions", "client": { "classes": [ { "parentPluginId": "actions", "id": "def-public.Plugin", "type": "Class", "tags": [], "label": "Plugin", "description": [], "signature": [ { "pluginId": "actions", "scope": "public", "docId": "kibActionsPluginApi", "section": "def-public.Plugin", "text": "Plugin" }, " implements ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.Plugin", "text": "Plugin" }, "<", { "pluginId": "actions", "scope": "public", "docId": "kibActionsPluginApi", "section": "def-public.ActionsPublicPluginSetup", "text": "ActionsPublicPluginSetup" }, ", void, object, object>" ], "path": "x-pack/plugins/actions/public/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-public.Plugin.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/actions/public/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-public.Plugin.Unnamed.$1", "type": "Object", "tags": [], "label": "ctx", "description": [], "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", "section": "def-public.PluginInitializerContext", "text": "PluginInitializerContext" }, "<", "Config", ">" ], "path": "x-pack/plugins/actions/public/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-public.Plugin.setup", "type": "Function", "tags": [], "label": "setup", "description": [], "signature": [ "() => ", { "pluginId": "actions", "scope": "public", "docId": "kibActionsPluginApi", "section": "def-public.ActionsPublicPluginSetup", "text": "ActionsPublicPluginSetup" } ], "path": "x-pack/plugins/actions/public/plugin.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-public.Plugin.start", "type": "Function", "tags": [], "label": "start", "description": [], "signature": [ "() => void" ], "path": "x-pack/plugins/actions/public/plugin.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [], "setup": { "parentPluginId": "actions", "id": "def-public.ActionsPublicPluginSetup", "type": "Interface", "tags": [], "label": "ActionsPublicPluginSetup", "description": [], "path": "x-pack/plugins/actions/public/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-public.ActionsPublicPluginSetup.validateEmailAddresses", "type": "Function", "tags": [], "label": "validateEmailAddresses", "description": [], "signature": [ "(emails: string[], options?: ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ValidateEmailAddressesOptions", "text": "ValidateEmailAddressesOptions" }, " | undefined) => ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ValidatedEmail", "text": "ValidatedEmail" }, "[]" ], "path": "x-pack/plugins/actions/public/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-public.ActionsPublicPluginSetup.validateEmailAddresses.$1", "type": "Array", "tags": [], "label": "emails", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/actions/public/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-public.ActionsPublicPluginSetup.validateEmailAddresses.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ValidateEmailAddressesOptions", "text": "ValidateEmailAddressesOptions" }, " | undefined" ], "path": "x-pack/plugins/actions/public/plugin.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true } }, "server": { "classes": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector", "type": "Class", "tags": [], "label": "CaseConnector", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.CaseConnector", "text": "CaseConnector" }, " extends ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.SubActionConnector", "text": "SubActionConnector" }, " implements ", "CaseConnectorInterface" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.Unnamed.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ServiceParams", "text": "ServiceParams" }, "" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.addComment", "type": "Function", "tags": [], "label": "addComment", "description": [], "signature": [ "({ incidentId, comment, }: { incidentId: string; comment: string; }) => Promise" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.addComment.$1", "type": "Object", "tags": [], "label": "{\n incidentId,\n comment,\n }", "description": [], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.addComment.$1.incidentId", "type": "string", "tags": [], "label": "incidentId", "description": [], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.addComment.$1.comment", "type": "string", "tags": [], "label": "comment", "description": [], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false } ] } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.createIncident", "type": "Function", "tags": [], "label": "createIncident", "description": [], "signature": [ "(incident: Record) => Promise<", "ExternalServiceIncidentResponse", ">" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.createIncident.$1", "type": "Object", "tags": [], "label": "incident", "description": [], "signature": [ "Record" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.updateIncident", "type": "Function", "tags": [], "label": "updateIncident", "description": [], "signature": [ "({ incidentId, incident, }: { incidentId: string; incident: Record; }) => Promise<", "ExternalServiceIncidentResponse", ">" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.updateIncident.$1", "type": "Object", "tags": [], "label": "{\n incidentId,\n incident,\n }", "description": [], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.updateIncident.$1.incidentId", "type": "string", "tags": [], "label": "incidentId", "description": [], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.updateIncident.$1.incident", "type": "Object", "tags": [], "label": "incident", "description": [], "signature": [ "{ [x: string]: unknown; }" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false } ] } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.getIncident", "type": "Function", "tags": [], "label": "getIncident", "description": [], "signature": [ "({ id }: { id: string; }) => Promise<", "ExternalServiceIncidentResponse", ">" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.getIncident.$1", "type": "Object", "tags": [], "label": "{ id }", "description": [], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.getIncident.$1.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false } ] } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.CaseConnector.pushToService", "type": "Function", "tags": [], "label": "pushToService", "description": [], "signature": [ "(params: ", "PushToServiceParams", ") => Promise<", "PushToServiceResponse", ">" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.CaseConnector.pushToService.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "PushToServiceParams" ], "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector", "type": "Class", "tags": [], "label": "SubActionConnector", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.SubActionConnector", "text": "SubActionConnector" }, "" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.SubActionConnector.logger", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ "Logger" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.connector", "type": "Object", "tags": [], "label": "connector", "description": [], "signature": [ "{ id: string; type: string; }" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.config", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.secrets", "type": "Uncategorized", "tags": [], "label": "secrets", "description": [], "signature": [ "Secrets" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.SubActionConnector.Unnamed.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ServiceParams", "text": "ServiceParams" }, "" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.registerSubAction", "type": "Function", "tags": [], "label": "registerSubAction", "description": [], "signature": [ "(subAction: ", "SubAction", ") => void" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.SubActionConnector.registerSubAction.$1", "type": "Object", "tags": [], "label": "subAction", "description": [], "signature": [ "SubAction" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.removeNullOrUndefinedFields", "type": "Function", "tags": [], "label": "removeNullOrUndefinedFields", "description": [], "signature": [ "(data: unknown) => unknown" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.SubActionConnector.removeNullOrUndefinedFields.$1", "type": "Unknown", "tags": [], "label": "data", "description": [], "signature": [ "unknown" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.getSubActions", "type": "Function", "tags": [], "label": "getSubActions", "description": [], "signature": [ "() => Map" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.getResponseErrorMessage", "type": "Function", "tags": [], "label": "getResponseErrorMessage", "description": [], "signature": [ "(error: ", "AxiosError", ") => string" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.SubActionConnector.getResponseErrorMessage.$1", "type": "Object", "tags": [], "label": "error", "description": [], "signature": [ "AxiosError", "" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.SubActionConnector.request", "type": "Function", "tags": [], "label": "request", "description": [], "signature": [ "({ url, data, method, responseSchema, headers, ...config }: { url: string; responseSchema: ", "Type", "; method?: ", "Method", " | undefined; } & ", "AxiosRequestConfig", ") => Promise<", "AxiosResponse", ">" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.SubActionConnector.request.$1", "type": "CompoundType", "tags": [], "label": "{\n url,\n data,\n method = 'get',\n responseSchema,\n headers,\n ...config\n }", "description": [], "signature": [ "{ url: string; responseSchema: ", "Type", "; method?: ", "Method", " | undefined; } & ", "AxiosRequestConfig", "" ], "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "actions", "id": "def-server.asHttpRequestExecutionSource", "type": "Function", "tags": [], "label": "asHttpRequestExecutionSource", "description": [], "signature": [ "(source: ", "KibanaRequest", ") => ", "HttpRequestExecutionSource" ], "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.asHttpRequestExecutionSource.$1", "type": "Object", "tags": [], "label": "source", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.asSavedObjectExecutionSource", "type": "Function", "tags": [], "label": "asSavedObjectExecutionSource", "description": [], "signature": [ "(source: Omit<", "SavedObjectReference", ", \"name\">) => ", "SavedObjectExecutionSource" ], "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.asSavedObjectExecutionSource.$1", "type": "Object", "tags": [], "label": "source", "description": [], "signature": [ "Omit<", "SavedObjectReference", ", \"name\">" ], "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "actions", "id": "def-server.ActionResult", "type": "Interface", "tags": [], "label": "ActionResult", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionResult", "text": "ActionResult" }, "" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ActionResult.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionResult.actionTypeId", "type": "string", "tags": [], "label": "actionTypeId", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionResult.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionResult.isMissingSecrets", "type": "CompoundType", "tags": [], "label": "isMissingSecrets", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionResult.config", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionResult.isPreconfigured", "type": "boolean", "tags": [], "label": "isPreconfigured", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionResult.isDeprecated", "type": "boolean", "tags": [], "label": "isDeprecated", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionsApiRequestHandlerContext", "type": "Interface", "tags": [], "label": "ActionsApiRequestHandlerContext", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ActionsApiRequestHandlerContext.getActionsClient", "type": "Function", "tags": [], "label": "getActionsClient", "description": [], "signature": [ "() => ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionsClient", "text": "ActionsClient" } ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.ActionsApiRequestHandlerContext.listTypes", "type": "Function", "tags": [], "label": "listTypes", "description": [], "signature": [ "(featureId?: string | undefined) => ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionType", "text": "ActionType" }, "[]" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "actions", "id": "def-server.ActionsApiRequestHandlerContext.listTypes.$1", "type": "string", "tags": [], "label": "featureId", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/actions/server/action_type_registry.ts", "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionsPlugin", "type": "Interface", "tags": [], "label": "ActionsPlugin", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ActionsPlugin.setup", "type": "Object", "tags": [], "label": "setup", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.PluginSetupContract", "text": "PluginSetupContract" } ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionsPlugin.start", "type": "Object", "tags": [], "label": "start", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.PluginStartContract", "text": "PluginStartContract" } ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionType", "type": "Interface", "tags": [], "label": "ActionType", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionType", "text": "ActionType" }, "" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ActionType.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionType.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionType.maxAttempts", "type": "number", "tags": [], "label": "maxAttempts", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionType.minimumLicenseRequired", "type": "CompoundType", "tags": [], "label": "minimumLicenseRequired", "description": [], "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionType.supportedFeatureIds", "type": "Array", "tags": [], "label": "supportedFeatureIds", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionType.validate", "type": "Object", "tags": [], "label": "validate", "description": [], "signature": [ "{ params?: ValidatorType | undefined; config?: ValidatorType | undefined; secrets?: ValidatorType | undefined; connector?: ((config: Config, secrets: Secrets) => string | null) | undefined; } | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionType.renderParameterTemplates", "type": "Function", "tags": [], "label": "renderParameterTemplates", "description": [], "signature": [ "((params: Params, variables: Record, actionId?: string | undefined) => Params) | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ActionType.renderParameterTemplates.$1", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "Params" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.ActionType.renderParameterTemplates.$2", "type": "Object", "tags": [], "label": "variables", "description": [], "signature": [ "Record" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.ActionType.renderParameterTemplates.$3", "type": "string", "tags": [], "label": "actionId", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.ActionType.executor", "type": "Function", "tags": [], "label": "executor", "description": [], "signature": [ "(options: ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionTypeExecutorOptions", "text": "ActionTypeExecutorOptions" }, ") => Promise<", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionTypeExecutorResult", "text": "ActionTypeExecutorResult" }, ">" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "actions", "id": "def-server.ActionType.executor.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionTypeExecutorOptions", "text": "ActionTypeExecutorOptions" }, "" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions", "type": "Interface", "tags": [], "label": "ActionTypeExecutorOptions", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionTypeExecutorOptions", "text": "ActionTypeExecutorOptions" }, "" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.actionId", "type": "string", "tags": [], "label": "actionId", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.services", "type": "Object", "tags": [], "label": "services", "description": [], "signature": [ "Services" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.config", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.secrets", "type": "Uncategorized", "tags": [], "label": "secrets", "description": [], "signature": [ "Secrets" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.params", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "Params" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.isEphemeral", "type": "CompoundType", "tags": [], "label": "isEphemeral", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeExecutorOptions.taskInfo", "type": "Object", "tags": [], "label": "taskInfo", "description": [], "signature": [ "TaskInfo", " | undefined" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.FindActionResult", "type": "Interface", "tags": [], "label": "FindActionResult", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.FindActionResult", "text": "FindActionResult" }, " extends ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionResult", "text": "ActionResult" }, "<", "ActionTypeConfig", ">" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.FindActionResult.referencedByCount", "type": "number", "tags": [], "label": "referencedByCount", "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.PreConfiguredAction", "type": "Interface", "tags": [], "label": "PreConfiguredAction", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.PreConfiguredAction", "text": "PreConfiguredAction" }, " extends ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionResult", "text": "ActionResult" }, "" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PreConfiguredAction.secrets", "type": "Uncategorized", "tags": [], "label": "secrets", "description": [], "signature": [ "Secrets" ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ServiceParams", "type": "Interface", "tags": [], "label": "ServiceParams", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ServiceParams", "text": "ServiceParams" }, "" ], "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.ServiceParams.connector", "type": "Object", "tags": [], "label": "connector", "description": [ "\nThe type is the connector type id. For example \".servicenow\"\nThe id is the connector's SavedObject UUID." ], "signature": [ "{ id: string; type: string; }" ], "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ServiceParams.config", "type": "Uncategorized", "tags": [], "label": "config", "description": [], "signature": [ "Config" ], "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ServiceParams.configurationUtilities", "type": "Object", "tags": [], "label": "configurationUtilities", "description": [], "signature": [ "ActionsConfigurationUtilities" ], "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ServiceParams.logger", "type": "Object", "tags": [], "label": "logger", "description": [], "signature": [ "Logger" ], "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ServiceParams.secrets", "type": "Uncategorized", "tags": [], "label": "secrets", "description": [], "signature": [ "Secrets" ], "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.ServiceParams.services", "type": "Object", "tags": [], "label": "services", "description": [], "signature": [ "Services" ], "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "actions", "id": "def-server.ACTION_SAVED_OBJECT_TYPE", "type": "string", "tags": [], "label": "ACTION_SAVED_OBJECT_TYPE", "description": [], "signature": [ "\"action\"" ], "path": "x-pack/plugins/actions/server/constants/saved_objects.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "{ readonly subAction: \"pushToService\"; readonly subActionParams: Readonly<{} & { incident: Readonly<{} & { title: string; description: string | null; tags: string[] | null; externalId: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/cases_webhook/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "{ readonly to: string[]; readonly message: string; readonly subject: string; readonly cc: string[]; readonly bcc: string[]; readonly kibanaFooterLink: Readonly<{} & { path: string; text: string; }>; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/email.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "{ readonly documents: Record[]; readonly indexOverride: string | null; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "{ readonly group?: string | undefined; readonly source?: string | undefined; readonly component?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly class?: string | undefined; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "{ readonly message: string; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "{ readonly body?: string | undefined; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; severity: string | null; urgency: string | null; impact: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }> | Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; dest_ip: string | string[] | null; malware_hash: string | string[] | null; malware_url: string | string[] | null; source_ip: string | string[] | null; priority: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }>" ], "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; parent: string | null; summary: string; externalId: string | null; priority: string | null; issueType: string | null; labels: string[] | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"issueTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"fieldsByIssueType\"; subActionParams: Readonly<{} & { id: string; }>; }> | Readonly<{} & { subAction: \"issues\"; subActionParams: Readonly<{} & { title: string; }>; }> | Readonly<{} & { subAction: \"issue\"; subActionParams: Readonly<{} & { id: string; }>; }>" ], "path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { name: string; description: string | null; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>" ], "path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionParamsType", "type": "Type", "tags": [], "label": "ActionParamsType", "description": [], "signature": [ "{ readonly message: string; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionsAuthorization", "type": "Type", "tags": [], "label": "ActionsAuthorization", "description": [], "signature": [ "{ ensureAuthorized: (operation: string, actionTypeId?: string | undefined) => Promise; }" ], "path": "x-pack/plugins/actions/server/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionsClient", "type": "Type", "tags": [], "label": "ActionsClient", "description": [], "signature": [ "{ execute: ({ actionId, params, source, relatedSavedObjects, }: Omit<", "ExecuteOptions", ", \"request\">) => Promise<", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionTypeExecutorResult", "text": "ActionTypeExecutorResult" }, ">; create: ({ action: { actionTypeId, name, config, secrets }, }: ", "CreateOptions", ") => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionResult", "text": "ActionResult" }, "<", "ActionTypeConfig", ">>; get: ({ id }: { id: string; }) => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionResult", "text": "ActionResult" }, "<", "ActionTypeConfig", ">>; update: ({ id, action }: ", "UpdateOptions", ") => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionResult", "text": "ActionResult" }, "<", "ActionTypeConfig", ">>; delete: ({ id }: { id: string; }) => Promise<{}>; getAll: () => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.FindActionResult", "text": "FindActionResult" }, "[]>; getBulk: (ids: string[]) => Promise<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionResult", "text": "ActionResult" }, "<", "ActionTypeConfig", ">[]>; getOAuthAccessToken: ({ type, options }: Readonly<{} & { type: \"client\" | \"jwt\"; options: Readonly<{} & { config: Readonly<{} & { clientId: string; jwtKeyId: string; userIdentifierValue: string; }>; tokenUrl: string; secrets: Readonly<{ privateKeyPassword?: string | undefined; } & { clientSecret: string; privateKey: string; }>; }> | Readonly<{} & { scope: string; config: Readonly<{} & { clientId: string; tenantId: string; }>; tokenUrl: string; secrets: Readonly<{} & { clientSecret: string; }>; }>; }>, configurationUtilities: ", "ActionsConfigurationUtilities", ") => Promise<{ accessToken: string | null; }>; enqueueExecution: (options: ", "ExecuteOptions", ") => Promise; ephemeralEnqueuedExecution: (options: ", "ExecuteOptions", ") => Promise<", { "pluginId": "taskManager", "scope": "server", "docId": "kibTaskManagerPluginApi", "section": "def-server.RunNowResult", "text": "RunNowResult" }, ">; listTypes: (featureId?: string | undefined) => Promise<", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionType", "text": "ActionType" }, "[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; isPreconfigured: (connectorId: string) => boolean; }" ], "path": "x-pack/plugins/actions/server/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", "tags": [], "label": "ActionTypeId", "description": [], "signature": [ "\".cases-webhook\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/cases_webhook/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", "tags": [], "label": "ActionTypeId", "description": [], "signature": [ "\".email\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/email.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", "tags": [], "label": "ActionTypeId", "description": [], "signature": [ "\".index\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", "tags": [], "label": "ActionTypeId", "description": [], "signature": [ "\".pagerduty\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", "tags": [], "label": "ActionTypeId", "description": [], "signature": [ "\".server-log\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", "tags": [], "label": "ActionTypeId", "description": [], "signature": [ "\".slack\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", "tags": [], "label": "ActionTypeId", "description": [], "signature": [ "\".webhook\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", "tags": [], "label": "ActionTypeId", "description": [], "signature": [ "\".jira\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", "tags": [], "label": "ActionTypeId", "description": [], "signature": [ "\".resilient\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ActionTypeId", "type": "string", "tags": [], "label": "ActionTypeId", "description": [], "signature": [ "\".teams\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ServiceNowITSMActionTypeId", "type": "string", "tags": [], "label": "ServiceNowITSMActionTypeId", "description": [], "signature": [ "\".servicenow\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-server.ServiceNowSIRActionTypeId", "type": "string", "tags": [], "label": "ServiceNowSIRActionTypeId", "description": [], "signature": [ "\".servicenow-sir\"" ], "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/config.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [], "setup": { "parentPluginId": "actions", "id": "def-server.PluginSetupContract", "type": "Interface", "tags": [], "label": "PluginSetupContract", "description": [], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.registerType", "type": "Function", "tags": [], "label": "registerType", "description": [], "signature": [ "(actionType: ", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionType", "text": "ActionType" }, ") => void" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.registerType.$1", "type": "Object", "tags": [], "label": "actionType", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionType", "text": "ActionType" }, "" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.registerSubActionConnectorType", "type": "Function", "tags": [], "label": "registerSubActionConnectorType", "description": [], "signature": [ "(connector: ", "SubActionConnectorType", ") => void" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.registerSubActionConnectorType.$1", "type": "Object", "tags": [], "label": "connector", "description": [], "signature": [ "SubActionConnectorType", "" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.isPreconfiguredConnector", "type": "Function", "tags": [], "label": "isPreconfiguredConnector", "description": [], "signature": [ "(connectorId: string) => boolean" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.isPreconfiguredConnector.$1", "type": "string", "tags": [], "label": "connectorId", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.getSubActionConnectorClass", "type": "Function", "tags": [], "label": "getSubActionConnectorClass", "description": [], "signature": [ "() => ", "IServiceAbstract", "" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.getCaseConnectorClass", "type": "Function", "tags": [], "label": "getCaseConnectorClass", "description": [], "signature": [ "() => ", "IServiceAbstract", "" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [], "returnComment": [] } ], "lifecycle": "setup", "initialIsOpen": true }, "start": { "parentPluginId": "actions", "id": "def-server.PluginStartContract", "type": "Interface", "tags": [], "label": "PluginStartContract", "description": [], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionTypeEnabled", "type": "Function", "tags": [], "label": "isActionTypeEnabled", "description": [], "signature": [ "(id: string, options?: { notifyUsage: boolean; } | undefined) => boolean" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionTypeEnabled.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionTypeEnabled.$2", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionTypeEnabled.$2.notifyUsage", "type": "boolean", "tags": [], "label": "notifyUsage", "description": [], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false } ] } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionExecutable", "type": "Function", "tags": [], "label": "isActionExecutable", "description": [], "signature": [ "(actionId: string, actionTypeId: string, options?: { notifyUsage: boolean; } | undefined) => boolean" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionExecutable.$1", "type": "string", "tags": [], "label": "actionId", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionExecutable.$2", "type": "string", "tags": [], "label": "actionTypeId", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionExecutable.$3", "type": "Object", "tags": [], "label": "options", "description": [], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginStartContract.isActionExecutable.$3.notifyUsage", "type": "boolean", "tags": [], "label": "notifyUsage", "description": [], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false } ] } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.getActionsClientWithRequest", "type": "Function", "tags": [], "label": "getActionsClientWithRequest", "description": [], "signature": [ "(request: ", "KibanaRequest", ") => Promise<", "PublicMethodsOf", "<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionsClient", "text": "ActionsClient" }, ">>" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginStartContract.getActionsClientWithRequest.$1", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest", "type": "Function", "tags": [], "label": "getActionsAuthorizationWithRequest", "description": [], "signature": [ "(request: ", "KibanaRequest", ") => ", "PublicMethodsOf", "<", { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.ActionsAuthorization", "text": "ActionsAuthorization" }, ">" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginStartContract.getActionsAuthorizationWithRequest.$1", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ "KibanaRequest", "" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.preconfiguredActions", "type": "Array", "tags": [], "label": "preconfiguredActions", "description": [], "signature": [ { "pluginId": "actions", "scope": "server", "docId": "kibActionsPluginApi", "section": "def-server.PreConfiguredAction", "text": "PreConfiguredAction" }, "<", "ActionTypeConfig", ", ", "ActionTypeSecrets", ">[]" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.renderActionParameterTemplates", "type": "Function", "tags": [], "label": "renderActionParameterTemplates", "description": [], "signature": [ "(actionTypeId: string, actionId: string, params: Params, variables: Record) => Params" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-server.PluginStartContract.renderActionParameterTemplates.$1", "type": "string", "tags": [], "label": "actionTypeId", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.renderActionParameterTemplates.$2", "type": "string", "tags": [], "label": "actionId", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.renderActionParameterTemplates.$3", "type": "Uncategorized", "tags": [], "label": "params", "description": [], "signature": [ "Params" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-server.PluginStartContract.renderActionParameterTemplates.$4", "type": "Object", "tags": [], "label": "variables", "description": [], "signature": [ "Record" ], "path": "x-pack/plugins/actions/server/plugin.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] } ], "lifecycle": "start", "initialIsOpen": true } }, "common": { "classes": [], "functions": [ { "parentPluginId": "actions", "id": "def-common.areValidFeatures", "type": "Function", "tags": [], "label": "areValidFeatures", "description": [], "signature": [ "(ids: string[]) => boolean" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.areValidFeatures.$1", "type": "Array", "tags": [], "label": "ids", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.buildAlertHistoryDocument", "type": "Function", "tags": [], "label": "buildAlertHistoryDocument", "description": [], "signature": [ "(variables: Record) => { event: { kind: string; }; kibana?: { alert: { actionGroupName?: string | undefined; actionGroup?: string | undefined; context?: { [x: string]: Record; } | undefined; id?: string | undefined; }; } | undefined; rule?: { type?: string | undefined; space?: string | undefined; params?: { [x: string]: Record; } | undefined; name?: string | undefined; id?: string | undefined; } | undefined; message?: unknown; tags?: string[] | undefined; '@timestamp': string; } | null" ], "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.buildAlertHistoryDocument.$1", "type": "Object", "tags": [], "label": "variables", "description": [], "signature": [ "Record" ], "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.getConnectorFeatureName", "type": "Function", "tags": [], "label": "getConnectorFeatureName", "description": [], "signature": [ "(id: string) => string" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.getConnectorFeatureName.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.hasMustacheTemplate", "type": "Function", "tags": [], "label": "hasMustacheTemplate", "description": [ "does the string contain `{{.*}}`?" ], "signature": [ "(string: string) => boolean" ], "path": "x-pack/plugins/actions/common/mustache_template.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.hasMustacheTemplate.$1", "type": "string", "tags": [], "label": "string", "description": [], "signature": [ "string" ], "path": "x-pack/plugins/actions/common/mustache_template.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.invalidEmailsAsMessage", "type": "Function", "tags": [], "label": "invalidEmailsAsMessage", "description": [], "signature": [ "(validatedEmails: ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ValidatedEmail", "text": "ValidatedEmail" }, "[]) => string | undefined" ], "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.invalidEmailsAsMessage.$1", "type": "Array", "tags": [], "label": "validatedEmails", "description": [], "signature": [ { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ValidatedEmail", "text": "ValidatedEmail" }, "[]" ], "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.isActionTypeExecutorResult", "type": "Function", "tags": [], "label": "isActionTypeExecutorResult", "description": [], "signature": [ "(result: unknown) => boolean" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.isActionTypeExecutorResult.$1", "type": "Unknown", "tags": [], "label": "result", "description": [], "signature": [ "unknown" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.validateEmailAddresses", "type": "Function", "tags": [], "label": "validateEmailAddresses", "description": [], "signature": [ "(allowedDomains: string[] | null, addresses: string[], options: ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ValidateEmailAddressesOptions", "text": "ValidateEmailAddressesOptions" }, ") => ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ValidatedEmail", "text": "ValidatedEmail" }, "[]" ], "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.validateEmailAddresses.$1", "type": "CompoundType", "tags": [], "label": "allowedDomains", "description": [], "signature": [ "string[] | null" ], "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "actions", "id": "def-common.validateEmailAddresses.$2", "type": "Array", "tags": [], "label": "addresses", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "actions", "id": "def-common.validateEmailAddresses.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ValidateEmailAddressesOptions", "text": "ValidateEmailAddressesOptions" } ], "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.validateEmailAddressesAsAlwaysValid", "type": "Function", "tags": [], "label": "validateEmailAddressesAsAlwaysValid", "description": [], "signature": [ "(addresses: string[]) => ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ValidatedEmail", "text": "ValidatedEmail" }, "[]" ], "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.validateEmailAddressesAsAlwaysValid.$1", "type": "Array", "tags": [], "label": "addresses", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.withoutMustacheTemplate", "type": "Function", "tags": [], "label": "withoutMustacheTemplate", "description": [ "filter strings that do not contain `{{.*}}`" ], "signature": [ "(strings: string[]) => string[]" ], "path": "x-pack/plugins/actions/common/mustache_template.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.withoutMustacheTemplate.$1", "type": "Array", "tags": [], "label": "strings", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/actions/common/mustache_template.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "actions", "id": "def-common.ActionResult", "type": "Interface", "tags": [], "label": "ActionResult", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.ActionResult.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionResult.actionTypeId", "type": "string", "tags": [], "label": "actionTypeId", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionResult.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionResult.config", "type": "Object", "tags": [], "label": "config", "description": [], "signature": [ "{ [x: string]: any; }" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionResult.isPreconfigured", "type": "boolean", "tags": [], "label": "isPreconfigured", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ActionsPublicConfigType", "type": "Interface", "tags": [], "label": "ActionsPublicConfigType", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.ActionsPublicConfigType.allowedEmailDomains", "type": "Array", "tags": [], "label": "allowedEmailDomains", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ActionType", "type": "Interface", "tags": [], "label": "ActionType", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.ActionType.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionType.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionType.enabled", "type": "boolean", "tags": [], "label": "enabled", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionType.enabledInConfig", "type": "boolean", "tags": [], "label": "enabledInConfig", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionType.enabledInLicense", "type": "boolean", "tags": [], "label": "enabledInLicense", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionType.minimumLicenseRequired", "type": "CompoundType", "tags": [], "label": "minimumLicenseRequired", "description": [], "signature": [ "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionType.supportedFeatureIds", "type": "Array", "tags": [], "label": "supportedFeatureIds", "description": [], "signature": [ "string[]" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult", "type": "Interface", "tags": [], "label": "ActionTypeExecutorResult", "description": [], "signature": [ { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionTypeExecutorResult", "text": "ActionTypeExecutorResult" }, "" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.actionId", "type": "string", "tags": [], "label": "actionId", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.status", "type": "CompoundType", "tags": [], "label": "status", "description": [], "signature": [ "\"error\" | \"ok\"" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.message", "type": "string", "tags": [], "label": "message", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.serviceMessage", "type": "string", "tags": [], "label": "serviceMessage", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.data", "type": "Uncategorized", "tags": [], "label": "data", "description": [], "signature": [ "Data | undefined" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorResult.retry", "type": "CompoundType", "tags": [], "label": "retry", "description": [], "signature": [ "boolean | Date | null | undefined" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.SNProductsConfigValue", "type": "Interface", "tags": [], "label": "SNProductsConfigValue", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.SNProductsConfigValue.table", "type": "string", "tags": [], "label": "table", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.SNProductsConfigValue.appScope", "type": "string", "tags": [], "label": "appScope", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.SNProductsConfigValue.useImportAPI", "type": "boolean", "tags": [], "label": "useImportAPI", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.SNProductsConfigValue.importSetTable", "type": "string", "tags": [], "label": "importSetTable", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.SNProductsConfigValue.commentFieldKey", "type": "string", "tags": [], "label": "commentFieldKey", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.SNProductsConfigValue.appId", "type": "string", "tags": [], "label": "appId", "description": [], "signature": [ "string | undefined" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ValidatedEmail", "type": "Interface", "tags": [], "label": "ValidatedEmail", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.ValidatedEmail.address", "type": "string", "tags": [], "label": "address", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ValidatedEmail.valid", "type": "boolean", "tags": [], "label": "valid", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.ValidatedEmail.reason", "type": "CompoundType", "tags": [], "label": "reason", "description": [], "signature": [ { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.InvalidEmailReason", "text": "InvalidEmailReason" }, " | undefined" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ValidateEmailAddressesOptions", "type": "Interface", "tags": [], "label": "ValidateEmailAddressesOptions", "description": [ "Options that can be used when validating email addresses" ], "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.ValidateEmailAddressesOptions.treatMustacheTemplatesAsValid", "type": "CompoundType", "tags": [], "label": "treatMustacheTemplatesAsValid", "description": [ "treat any address which contains a mustache template as valid" ], "signature": [ "boolean | undefined" ], "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", "deprecated": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "actions", "id": "def-common.AdditionalEmailServices", "type": "Enum", "tags": [], "label": "AdditionalEmailServices", "description": [], "path": "x-pack/plugins/actions/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.InvalidEmailReason", "type": "Enum", "tags": [], "label": "InvalidEmailReason", "description": [], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "actions", "id": "def-common.ACTIONS_FEATURE_ID", "type": "string", "tags": [], "label": "ACTIONS_FEATURE_ID", "description": [], "signature": [ "\"actions\"" ], "path": "x-pack/plugins/actions/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ActionTypeExecutorRawResult", "type": "Type", "tags": [], "label": "ActionTypeExecutorRawResult", "description": [], "signature": [ { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.ActionTypeExecutorResult", "text": "ActionTypeExecutorResult" }, " & { error?: Error | undefined; }" ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ALERT_HISTORY_PREFIX", "type": "string", "tags": [], "label": "ALERT_HISTORY_PREFIX", "description": [], "signature": [ "\"kibana-alert-history-\"" ], "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.AlertHistoryDefaultIndexName", "type": "string", "tags": [], "label": "AlertHistoryDefaultIndexName", "description": [], "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.AlertHistoryDocumentTemplate", "type": "CompoundType", "tags": [], "label": "AlertHistoryDocumentTemplate", "description": [], "signature": [ "Readonly<{ event: { kind: string; }; kibana?: { alert: { actionGroupName?: string | undefined; actionGroup?: string | undefined; context?: { [x: string]: Record; } | undefined; id?: string | undefined; }; } | undefined; rule?: { type?: string | undefined; space?: string | undefined; params?: { [x: string]: Record; } | undefined; name?: string | undefined; id?: string | undefined; } | undefined; message?: unknown; tags?: string[] | undefined; '@timestamp': string; }> | null" ], "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.AlertHistoryEsIndexConnectorId", "type": "string", "tags": [], "label": "AlertHistoryEsIndexConnectorId", "description": [], "signature": [ "\"preconfigured-alert-history-es-index\"" ], "path": "x-pack/plugins/actions/common/alert_history_schema.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.AlertingConnectorFeatureId", "type": "string", "tags": [], "label": "AlertingConnectorFeatureId", "description": [], "signature": [ "\"alerting\"" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.AsApiContract", "type": "Type", "tags": [], "label": "AsApiContract", "description": [], "signature": [ "{ [K in keyof T as CamelToSnake>>]: T[K]; }" ], "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.BASE_ACTION_API_PATH", "type": "string", "tags": [], "label": "BASE_ACTION_API_PATH", "description": [], "signature": [ "\"/api/actions\"" ], "path": "x-pack/plugins/actions/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.CasesConnectorFeatureId", "type": "string", "tags": [], "label": "CasesConnectorFeatureId", "description": [], "signature": [ "\"cases\"" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.DEFAULT_ALERTS_GROUPING_KEY", "type": "string", "tags": [], "label": "DEFAULT_ALERTS_GROUPING_KEY", "description": [], "signature": [ "\"{{rule.id}}:{{alert.id}}\"" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.FIELD_PREFIX", "type": "string", "tags": [], "label": "FIELD_PREFIX", "description": [], "signature": [ "\"u_\"" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.INTERNAL_BASE_ACTION_API_PATH", "type": "string", "tags": [], "label": "INTERNAL_BASE_ACTION_API_PATH", "description": [], "signature": [ "\"/internal/actions\"" ], "path": "x-pack/plugins/actions/common/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.RewriteRequestCase", "type": "Type", "tags": [], "label": "RewriteRequestCase", "description": [], "signature": [ "(requested: ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.AsApiContract", "text": "AsApiContract" }, ") => T" ], "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "actions", "id": "def-common.RewriteRequestCase.$1", "type": "Object", "tags": [], "label": "requested", "description": [], "signature": [ "{ [K in keyof T as CamelToSnake>>]: T[K]; }" ], "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.RewriteResponseCase", "type": "Type", "tags": [], "label": "RewriteResponseCase", "description": [], "signature": [ "(responded: T) => T extends (infer Item)[] ? ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.AsApiContract", "text": "AsApiContract" }, "[] : ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.AsApiContract", "text": "AsApiContract" }, "" ], "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "actions", "id": "def-common.RewriteResponseCase.$1", "type": "Uncategorized", "tags": [], "label": "responded", "description": [], "signature": [ "T" ], "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.SecurityConnectorFeatureId", "type": "string", "tags": [], "label": "SecurityConnectorFeatureId", "description": [], "signature": [ "\"siem\"" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ServiceNowITOMActionTypeId", "type": "string", "tags": [], "label": "ServiceNowITOMActionTypeId", "description": [], "signature": [ "\".servicenow-itom\"" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ServiceNowITSMActionTypeId", "type": "string", "tags": [], "label": "ServiceNowITSMActionTypeId", "description": [], "signature": [ "\".servicenow\"" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.serviceNowITSMTable", "type": "string", "tags": [], "label": "serviceNowITSMTable", "description": [], "signature": [ "\"incident\"" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.ServiceNowSIRActionTypeId", "type": "string", "tags": [], "label": "ServiceNowSIRActionTypeId", "description": [], "signature": [ "\".servicenow-sir\"" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.serviceNowSIRTable", "type": "string", "tags": [], "label": "serviceNowSIRTable", "description": [], "signature": [ "\"sn_si_incident\"" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.SNProductsConfig", "type": "Type", "tags": [], "label": "SNProductsConfig", "description": [], "signature": [ "{ [x: string]: ", { "pluginId": "actions", "scope": "common", "docId": "kibActionsPluginApi", "section": "def-common.SNProductsConfigValue", "text": "SNProductsConfigValue" }, "; }" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.UptimeConnectorFeatureId", "type": "string", "tags": [], "label": "UptimeConnectorFeatureId", "description": [], "signature": [ "\"uptime\"" ], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "actions", "id": "def-common.AlertingConnectorFeature", "type": "Object", "tags": [], "label": "AlertingConnectorFeature", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.AlertingConnectorFeature.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.AlertingConnectorFeature.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.CasesConnectorFeature", "type": "Object", "tags": [], "label": "CasesConnectorFeature", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.CasesConnectorFeature.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.CasesConnectorFeature.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.MustacheInEmailRegExp", "type": "Object", "tags": [], "label": "MustacheInEmailRegExp", "description": [], "signature": [ "RegExp" ], "path": "x-pack/plugins/actions/common/mustache_template.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.SecuritySolutionFeature", "type": "Object", "tags": [], "label": "SecuritySolutionFeature", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.SecuritySolutionFeature.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.SecuritySolutionFeature.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig", "type": "Object", "tags": [], "label": "snExternalServiceConfig", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenow", "type": "Object", "tags": [], "label": "'.servicenow'", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenow.importSetTable", "type": "string", "tags": [], "label": "importSetTable", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenow.appScope", "type": "string", "tags": [], "label": "appScope", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenow.table", "type": "string", "tags": [], "label": "table", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenow.useImportAPI", "type": "boolean", "tags": [], "label": "useImportAPI", "description": [], "signature": [ "true" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenow.commentFieldKey", "type": "string", "tags": [], "label": "commentFieldKey", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenow.appId", "type": "string", "tags": [], "label": "appId", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false } ] }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowsir", "type": "Object", "tags": [], "label": "'.servicenow-sir'", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowsir.importSetTable", "type": "string", "tags": [], "label": "importSetTable", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowsir.appScope", "type": "string", "tags": [], "label": "appScope", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowsir.table", "type": "string", "tags": [], "label": "table", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowsir.useImportAPI", "type": "boolean", "tags": [], "label": "useImportAPI", "description": [], "signature": [ "true" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowsir.commentFieldKey", "type": "string", "tags": [], "label": "commentFieldKey", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowsir.appId", "type": "string", "tags": [], "label": "appId", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false } ] }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowitom", "type": "Object", "tags": [], "label": "'.servicenow-itom'", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowitom.importSetTable", "type": "string", "tags": [], "label": "importSetTable", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowitom.appScope", "type": "string", "tags": [], "label": "appScope", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowitom.table", "type": "string", "tags": [], "label": "table", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowitom.useImportAPI", "type": "boolean", "tags": [], "label": "useImportAPI", "description": [], "signature": [ "false" ], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig..servicenowitom.commentFieldKey", "type": "string", "tags": [], "label": "commentFieldKey", "description": [], "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "actions", "id": "def-common.UptimeConnectorFeature", "type": "Object", "tags": [], "label": "UptimeConnectorFeature", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false, "children": [ { "parentPluginId": "actions", "id": "def-common.UptimeConnectorFeature.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false }, { "parentPluginId": "actions", "id": "def-common.UptimeConnectorFeature.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "x-pack/plugins/actions/common/connector_feature_config.ts", "deprecated": false } ], "initialIsOpen": false } ] } }