kibana/api_docs/kbn_cloud_security_posture_common.devdocs.json

2283 lines
No EOL
87 KiB
JSON

{
"id": "@kbn/cloud-security-posture-common",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.UiMetricService",
"type": "Class",
"tags": [],
"label": "UiMetricService",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/ui_metrics.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.UiMetricService.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(usageCollection: ",
{
"pluginId": "usageCollection",
"scope": "public",
"docId": "kibUsageCollectionPluginApi",
"section": "def-public.UsageCollectionSetup",
"text": "UsageCollectionSetup"
},
") => void"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/ui_metrics.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.UiMetricService.setup.$1",
"type": "Object",
"tags": [],
"label": "usageCollection",
"description": [],
"signature": [
{
"pluginId": "usageCollection",
"scope": "public",
"docId": "kibUsageCollectionPluginApi",
"section": "def-public.UsageCollectionSetup",
"text": "UsageCollectionSetup"
}
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/ui_metrics.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.UiMetricService.trackUiMetric",
"type": "Function",
"tags": [],
"label": "trackUiMetric",
"description": [],
"signature": [
"(metricType: string, eventName: ",
"CloudSecurityUiCounters",
") => void"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/ui_metrics.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.UiMetricService.trackUiMetric.$1",
"type": "string",
"tags": [],
"label": "metricType",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/ui_metrics.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.UiMetricService.trackUiMetric.$2",
"type": "CompoundType",
"tags": [],
"label": "eventName",
"description": [],
"signature": [
"CloudSecurityUiCounters"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/ui_metrics.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildGenericEntityFlyoutPreviewQuery",
"type": "Function",
"tags": [],
"label": "buildGenericEntityFlyoutPreviewQuery",
"description": [],
"signature": [
"(field: string, queryValue?: string | undefined, status?: string | undefined, queryField?: string | undefined) => { bool: { filter: ({ bool: { should: { term: { [x: string]: string; }; }[]; minimum_should_match: number; }; } | undefined)[]; }; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildGenericEntityFlyoutPreviewQuery.$1",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildGenericEntityFlyoutPreviewQuery.$2",
"type": "string",
"tags": [],
"label": "queryValue",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildGenericEntityFlyoutPreviewQuery.$3",
"type": "string",
"tags": [],
"label": "status",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildGenericEntityFlyoutPreviewQuery.$4",
"type": "string",
"tags": [],
"label": "queryField",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildMisconfigurationEntityFlyoutPreviewQuery",
"type": "Function",
"tags": [],
"label": "buildMisconfigurationEntityFlyoutPreviewQuery",
"description": [],
"signature": [
"(field: string, queryValue?: string | undefined, status?: string | undefined) => { bool: { filter: ({ bool: { should: { term: { [x: string]: string; }; }[]; minimum_should_match: number; }; } | undefined)[]; }; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildMisconfigurationEntityFlyoutPreviewQuery.$1",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildMisconfigurationEntityFlyoutPreviewQuery.$2",
"type": "string",
"tags": [],
"label": "queryValue",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildMisconfigurationEntityFlyoutPreviewQuery.$3",
"type": "string",
"tags": [],
"label": "status",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildMutedRulesFilter",
"type": "Function",
"tags": [],
"label": "buildMutedRulesFilter",
"description": [],
"signature": [
"(rulesStates: Record<string, Readonly<{} & { muted: boolean; rule_id: string; rule_number: string; benchmark_id: string; benchmark_version: string; }>>) => ",
"QueryDslQueryContainer",
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildMutedRulesFilter.$1",
"type": "Object",
"tags": [],
"label": "rulesStates",
"description": [],
"signature": [
"Record<string, Readonly<{} & { muted: boolean; rule_id: string; rule_number: string; benchmark_id: string; benchmark_version: string; }>>"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildVulnerabilityEntityFlyoutPreviewQuery",
"type": "Function",
"tags": [],
"label": "buildVulnerabilityEntityFlyoutPreviewQuery",
"description": [],
"signature": [
"(field: string, queryValue?: string | undefined, status?: string | undefined) => { bool: { filter: ({ bool: { should: { term: { [x: string]: string; }; }[]; minimum_should_match: number; }; } | undefined)[]; }; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildVulnerabilityEntityFlyoutPreviewQuery.$1",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildVulnerabilityEntityFlyoutPreviewQuery.$2",
"type": "string",
"tags": [],
"label": "queryValue",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.buildVulnerabilityEntityFlyoutPreviewQuery.$3",
"type": "string",
"tags": [],
"label": "status",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.createDetectionRule",
"type": "Function",
"tags": [],
"label": "createDetectionRule",
"description": [],
"signature": [
"({ http, rule, }: { http: ",
"HttpSetup",
"; rule: ",
"RuleCreateProps",
"; }) => Promise<",
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.RuleResponse",
"text": "RuleResponse"
},
">"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/rules/create_detection_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.createDetectionRule.$1",
"type": "Object",
"tags": [],
"label": "{\n http,\n rule,\n}",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/rules/create_detection_rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.createDetectionRule.$1.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
"HttpSetup"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/rules/create_detection_rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.createDetectionRule.$1.rule",
"type": "Object",
"tags": [],
"label": "rule",
"description": [],
"signature": [
"RuleCreateProps"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/rules/create_detection_rule.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.extractErrorMessage",
"type": "Function",
"tags": [],
"label": "extractErrorMessage",
"description": [],
"signature": [
"(e: unknown, fallbackMessage?: string | undefined) => string"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.extractErrorMessage.$1",
"type": "Unknown",
"tags": [],
"label": "e",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.extractErrorMessage.$2",
"type": "string",
"tags": [],
"label": "fallbackMessage",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.generateBenchmarkRuleTags",
"type": "Function",
"tags": [],
"label": "generateBenchmarkRuleTags",
"description": [],
"signature": [
"(rule: Readonly<{ references?: string | undefined; impact?: string | undefined; reference?: string | undefined; default_value?: string | undefined; } & { id: string; version: string; name: string; tags: string[]; description: string; section: string; audit: string; benchmark: Readonly<{ posture_type?: \"kspm\" | \"cspm\" | undefined; rule_number?: string | undefined; } & { id: string; version: string; name: string; }>; profile_applicability: string; rationale: string; rego_rule_id: string; remediation: string; }>) => string[]"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/rules/detection_rules.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.generateBenchmarkRuleTags.$1",
"type": "Object",
"tags": [],
"label": "rule",
"description": [],
"signature": [
"Readonly<{ references?: string | undefined; impact?: string | undefined; reference?: string | undefined; default_value?: string | undefined; } & { id: string; version: string; name: string; tags: string[]; description: string; section: string; audit: string; benchmark: Readonly<{ posture_type?: \"kspm\" | \"cspm\" | undefined; rule_number?: string | undefined; } & { id: string; version: string; name: string; }>; profile_applicability: string; rationale: string; rego_rule_id: string; remediation: string; }>"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/rules/detection_rules.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.getAbbreviatedNumber",
"type": "Function",
"tags": [],
"label": "getAbbreviatedNumber",
"description": [
"\nReturns an abbreviated number when the value is greater than or equal to 1000.\nThe abbreviated number is formatted using numeral:\n- thousand: k\n- million: m\n- billion: b\n- trillion: t"
],
"signature": [
"(value: number) => string | number"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/get_abbreviated_number.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.getAbbreviatedNumber.$1",
"type": "number",
"tags": [],
"label": "value",
"description": [],
"signature": [
"number"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/utils/get_abbreviated_number.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.getFindingsDetectionRuleSearchTags",
"type": "Function",
"tags": [],
"label": "getFindingsDetectionRuleSearchTags",
"description": [],
"signature": [
"(cspBenchmarkRule: Readonly<{ references?: string | undefined; impact?: string | undefined; reference?: string | undefined; default_value?: string | undefined; } & { id: string; version: string; name: string; tags: string[]; description: string; section: string; audit: string; benchmark: Readonly<{ posture_type?: \"kspm\" | \"cspm\" | undefined; rule_number?: string | undefined; } & { id: string; version: string; name: string; }>; profile_applicability: string; rationale: string; rego_rule_id: string; remediation: string; }>) => string[]"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/rules/detection_rules.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.getFindingsDetectionRuleSearchTags.$1",
"type": "Object",
"tags": [],
"label": "cspBenchmarkRule",
"description": [],
"signature": [
"Readonly<{ references?: string | undefined; impact?: string | undefined; reference?: string | undefined; default_value?: string | undefined; } & { id: string; version: string; name: string; tags: string[]; description: string; section: string; audit: string; benchmark: Readonly<{ posture_type?: \"kspm\" | \"cspm\" | undefined; rule_number?: string | undefined; } & { id: string; version: string; name: string; }>; profile_applicability: string; rationale: string; rego_rule_id: string; remediation: string; }>"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/rules/detection_rules.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupBothPolicy",
"type": "Interface",
"tags": [],
"label": "BaseCspSetupBothPolicy",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupBothPolicy.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"\"indexed\" | \"indexing\" | \"unprivileged\" | \"index-timeout\" | \"not-deployed\" | \"not-installed\" | \"waiting_for_results\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupBothPolicy.installedPackagePolicies",
"type": "number",
"tags": [],
"label": "installedPackagePolicies",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupBothPolicy.healthyAgents",
"type": "number",
"tags": [],
"label": "healthyAgents",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupStatus",
"type": "Interface",
"tags": [],
"label": "BaseCspSetupStatus",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupStatus.indicesDetails",
"type": "Array",
"tags": [],
"label": "indicesDetails",
"description": [],
"signature": [
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.IndexDetails",
"text": "IndexDetails"
},
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupStatus.latestPackageVersion",
"type": "string",
"tags": [],
"label": "latestPackageVersion",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupStatus.cspm",
"type": "Object",
"tags": [],
"label": "cspm",
"description": [],
"signature": [
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.BaseCspSetupBothPolicy",
"text": "BaseCspSetupBothPolicy"
}
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupStatus.kspm",
"type": "Object",
"tags": [],
"label": "kspm",
"description": [],
"signature": [
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.BaseCspSetupBothPolicy",
"text": "BaseCspSetupBothPolicy"
}
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupStatus.vuln_mgmt",
"type": "Object",
"tags": [],
"label": "vuln_mgmt",
"description": [],
"signature": [
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.BaseCspSetupBothPolicy",
"text": "BaseCspSetupBothPolicy"
}
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupStatus.isPluginInitialized",
"type": "boolean",
"tags": [],
"label": "isPluginInitialized",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupStatus.installedPackageVersion",
"type": "string",
"tags": [],
"label": "installedPackageVersion",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupStatus.hasMisconfigurationsFindings",
"type": "CompoundType",
"tags": [],
"label": "hasMisconfigurationsFindings",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BaseCspSetupStatus.hasVulnerabilitiesFindings",
"type": "CompoundType",
"tags": [],
"label": "hasVulnerabilitiesFindings",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding",
"type": "Interface",
"tags": [],
"label": "CspFinding",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.timestamp",
"type": "string",
"tags": [],
"label": "'@timestamp'",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.cluster_id",
"type": "string",
"tags": [],
"label": "cluster_id",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.orchestrator",
"type": "Object",
"tags": [],
"label": "orchestrator",
"description": [],
"signature": [
"CspFindingOrchestrator | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.cloud",
"type": "Object",
"tags": [],
"label": "cloud",
"description": [],
"signature": [
"CspFindingCloud | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.result",
"type": "Object",
"tags": [],
"label": "result",
"description": [],
"signature": [
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.CspFindingResult",
"text": "CspFindingResult"
}
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.resource",
"type": "Object",
"tags": [],
"label": "resource",
"description": [],
"signature": [
"CspFindingResource"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.rule",
"type": "Object",
"tags": [],
"label": "rule",
"description": [],
"signature": [
"{ readonly references?: string | undefined; readonly impact?: string | undefined; readonly reference?: string | undefined; readonly default_value?: string | undefined; readonly id: string; readonly version: string; readonly name: string; readonly tags: string[]; readonly description: string; readonly section: string; readonly audit: string; readonly benchmark: Readonly<{ posture_type?: \"kspm\" | \"cspm\" | undefined; rule_number?: string | undefined; } & { id: string; version: string; name: string; }>; readonly profile_applicability: string; readonly rationale: string; readonly rego_rule_id: string; readonly remediation: string; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.host",
"type": "Object",
"tags": [],
"label": "host",
"description": [],
"signature": [
"CspFindingHost"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.event",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"EcsEvent"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.data_stream",
"type": "Object",
"tags": [],
"label": "data_stream",
"description": [],
"signature": [
"EcsDataStream"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.observer",
"type": "Object",
"tags": [],
"label": "observer",
"description": [],
"signature": [
"EcsObserver"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.agent",
"type": "Object",
"tags": [],
"label": "agent",
"description": [],
"signature": [
"CspFindingAgent"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFinding.ecs",
"type": "Object",
"tags": [],
"label": "ecs",
"description": [],
"signature": [
"{ version: string; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFindingResult",
"type": "Interface",
"tags": [],
"label": "CspFindingResult",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFindingResult.evaluation",
"type": "CompoundType",
"tags": [],
"label": "evaluation",
"description": [],
"signature": [
"\"failed\" | \"passed\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFindingResult.expected",
"type": "Object",
"tags": [],
"label": "expected",
"description": [],
"signature": [
"Record<string, unknown> | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspFindingResult.evidence",
"type": "Object",
"tags": [],
"label": "evidence",
"description": [],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/findings.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspNavigationItem",
"type": "Interface",
"tags": [],
"label": "CspNavigationItem",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/navigation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspNavigationItem.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/navigation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspNavigationItem.path",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/navigation.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspNavigationItem.disabled",
"type": "CompoundType",
"tags": [],
"label": "disabled",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/navigation.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspPageNavigationItem",
"type": "Interface",
"tags": [],
"label": "CspPageNavigationItem",
"description": [],
"signature": [
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.CspPageNavigationItem",
"text": "CspPageNavigationItem"
},
" extends ",
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.CspNavigationItem",
"text": "CspNavigationItem"
}
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/navigation.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspPageNavigationItem.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"cloud_security_posture-dashboard\" | \"cloud_security_posture-cspm-dashboard\" | \"cloud_security_posture-kspm-dashboard\" | \"cloud_security_posture-vulnerability_dashboard\" | \"cloud_security_posture-findings\" | \"cloud_security_posture-benchmarks\" | \"cloud_security_posture-benchmarks-rules\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/navigation.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding",
"type": "Interface",
"tags": [],
"label": "CspVulnerabilityFinding",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.timestamp",
"type": "string",
"tags": [],
"label": "'@timestamp'",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.resource",
"type": "Object",
"tags": [],
"label": "resource",
"description": [],
"signature": [
"{ id: string; name: string; } | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.event",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"EcsEvent"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.vulnerability",
"type": "Object",
"tags": [],
"label": "vulnerability",
"description": [],
"signature": [
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.Vulnerability",
"text": "Vulnerability"
}
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.ecs",
"type": "Object",
"tags": [],
"label": "ecs",
"description": [],
"signature": [
"{ version: string; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.host",
"type": "Object",
"tags": [],
"label": "host",
"description": [],
"signature": [
"{ os: { name: string; kernel: string; codename: string; type: string; platform: string; version: string; family: string; }; id: string; name: string; containerized: boolean; ip: string[]; mac: string[]; hostname: string; architecture: string; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.agent",
"type": "Object",
"tags": [],
"label": "agent",
"description": [],
"signature": [
"{ ephemeral_id: string; id: string; name: string; type: string; version: string; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.cloud",
"type": "Object",
"tags": [],
"label": "cloud",
"description": [],
"signature": [
"{ image?: { id: string; } | undefined; provider?: string | undefined; instance?: { id: string; } | undefined; machine?: { type: string; } | undefined; region: string; availability_zone?: string | undefined; service?: { name: string; } | undefined; account?: { id: string; } | undefined; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.cloudbeat",
"type": "Object",
"tags": [],
"label": "cloudbeat",
"description": [],
"signature": [
"{ version: string; commit_sha: string; commit_time: string; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.package",
"type": "Object",
"tags": [],
"label": "package",
"description": [],
"signature": [
"{ version?: string | string[] | undefined; name?: string | string[] | undefined; fixed_version?: string | string[] | undefined; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.data_stream",
"type": "Object",
"tags": [],
"label": "data_stream",
"description": [],
"signature": [
"EcsDataStream"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspVulnerabilityFinding.observer",
"type": "Object",
"tags": [],
"label": "observer",
"description": [],
"signature": [
"EcsObserver"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.IndexDetails",
"type": "Interface",
"tags": [],
"label": "IndexDetails",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.IndexDetails.index",
"type": "string",
"tags": [],
"label": "index",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.IndexDetails.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"\"empty\" | \"unprivileged\" | \"not-empty\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.RuleResponse",
"type": "Interface",
"tags": [],
"label": "RuleResponse",
"description": [],
"signature": [
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.RuleResponse",
"text": "RuleResponse"
},
" extends ",
"RuleCreateProps"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/rules/rule.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.RuleResponse.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/rules/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability",
"type": "Interface",
"tags": [],
"label": "Vulnerability",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.published_date",
"type": "string",
"tags": [],
"label": "published_date",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.score",
"type": "Object",
"tags": [],
"label": "score",
"description": [],
"signature": [
"{ version?: string | undefined; base?: number | undefined; } | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.cwe",
"type": "Array",
"tags": [],
"label": "cwe",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | string[]"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.reference",
"type": "CompoundType",
"tags": [],
"label": "reference",
"description": [],
"signature": [
"string | string[]"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.severity",
"type": "CompoundType",
"tags": [],
"label": "severity",
"description": [],
"signature": [
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.VulnSeverity",
"text": "VulnSeverity"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.cvss",
"type": "Object",
"tags": [],
"label": "cvss",
"description": [],
"signature": [
"{ nvd: ",
"VectorScoreBase",
"; redhat?: ",
"VectorScoreBase",
" | undefined; ghsa?: ",
"VectorScoreBase",
" | undefined; } | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.data_source",
"type": "Object",
"tags": [],
"label": "data_source",
"description": [],
"signature": [
"{ ID: string; Name: string; URL: string; } | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.enumeration",
"type": "string",
"tags": [],
"label": "enumeration",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.classification",
"type": "string",
"tags": [],
"label": "classification",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.Vulnerability.scanner",
"type": "Object",
"tags": [],
"label": "scanner",
"description": [],
"signature": [
"{ vendor: string; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/schema/vulnerabilities/csp_vulnerability_finding.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BenchmarkId",
"type": "Type",
"tags": [],
"label": "BenchmarkId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/types_old.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BenchmarkName",
"type": "Type",
"tags": [],
"label": "BenchmarkName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/types_old.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.BenchmarksCisId",
"type": "Type",
"tags": [],
"label": "BenchmarksCisId",
"description": [],
"signature": [
"\"cis_k8s\" | \"cis_azure\" | \"cis_aws\" | \"cis_eks\" | \"cis_gcp\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/benchmark.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CDR_3RD_PARTY_RETENTION_POLICY",
"type": "string",
"tags": [],
"label": "CDR_3RD_PARTY_RETENTION_POLICY",
"description": [],
"signature": [
"\"90d\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CDR_LATEST_NATIVE_MISCONFIGURATIONS_INDEX_PATTERN",
"type": "string",
"tags": [],
"label": "CDR_LATEST_NATIVE_MISCONFIGURATIONS_INDEX_PATTERN",
"description": [],
"signature": [
"\"logs-cloud_security_posture.findings_latest-default\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CDR_LATEST_NATIVE_VULNERABILITIES_INDEX_PATTERN",
"type": "string",
"tags": [],
"label": "CDR_LATEST_NATIVE_VULNERABILITIES_INDEX_PATTERN",
"description": [],
"signature": [
"\"logs-cloud_security_posture.vulnerabilities_latest-default\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CDR_LATEST_THIRD_PARTY_MISCONFIGURATIONS_INDEX_PATTERN",
"type": "string",
"tags": [],
"label": "CDR_LATEST_THIRD_PARTY_MISCONFIGURATIONS_INDEX_PATTERN",
"description": [],
"signature": [
"\"security_solution-*.misconfiguration_latest\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CDR_LATEST_THIRD_PARTY_VULNERABILITIES_INDEX_PATTERN",
"type": "string",
"tags": [],
"label": "CDR_LATEST_THIRD_PARTY_VULNERABILITIES_INDEX_PATTERN",
"description": [],
"signature": [
"\"security_solution-*.vulnerability_latest\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CDR_MISCONFIGURATIONS_DATA_VIEW_ID_PREFIX",
"type": "string",
"tags": [],
"label": "CDR_MISCONFIGURATIONS_DATA_VIEW_ID_PREFIX",
"description": [],
"signature": [
"\"security_solution_cdr_latest_misconfigurations\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CDR_MISCONFIGURATIONS_DATA_VIEW_NAME",
"type": "string",
"tags": [],
"label": "CDR_MISCONFIGURATIONS_DATA_VIEW_NAME",
"description": [],
"signature": [
"\"Latest Cloud Security Misconfigurations\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CDR_MISCONFIGURATIONS_INDEX_PATTERN",
"type": "string",
"tags": [],
"label": "CDR_MISCONFIGURATIONS_INDEX_PATTERN",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CDR_VULNERABILITIES_INDEX_PATTERN",
"type": "string",
"tags": [],
"label": "CDR_VULNERABILITIES_INDEX_PATTERN",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CLOUD_SECURITY_POSTURE_BASE_PATH",
"type": "string",
"tags": [],
"label": "CLOUD_SECURITY_POSTURE_BASE_PATH",
"description": [
"The base path for all cloud security posture pages."
],
"signature": [
"\"/cloud_security_posture\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CloudSecurityPosturePageId",
"type": "Type",
"tags": [],
"label": "CloudSecurityPosturePageId",
"description": [],
"signature": [
"\"cloud_security_posture-dashboard\" | \"cloud_security_posture-cspm-dashboard\" | \"cloud_security_posture-kspm-dashboard\" | \"cloud_security_posture-vulnerability_dashboard\" | \"cloud_security_posture-findings\" | \"cloud_security_posture-benchmarks\" | \"cloud_security_posture-benchmarks-rules\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/navigation.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CSP_GET_BENCHMARK_RULES_STATE_API_CURRENT_VERSION",
"type": "string",
"tags": [],
"label": "CSP_GET_BENCHMARK_RULES_STATE_API_CURRENT_VERSION",
"description": [],
"signature": [
"\"1\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CSP_GET_BENCHMARK_RULES_STATE_ROUTE_PATH",
"type": "string",
"tags": [],
"label": "CSP_GET_BENCHMARK_RULES_STATE_ROUTE_PATH",
"description": [],
"signature": [
"\"/internal/cloud_security_posture/rules/_get_states\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CSP_MISCONFIGURATIONS_DATASET",
"type": "string",
"tags": [],
"label": "CSP_MISCONFIGURATIONS_DATASET",
"description": [],
"signature": [
"\"cloud_security_posture.findings\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CSP_MOMENT_FORMAT",
"type": "string",
"tags": [],
"label": "CSP_MOMENT_FORMAT",
"description": [],
"signature": [
"\"MMMM D, YYYY @ HH:mm:ss.SSS\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspBenchmarksPage",
"type": "Type",
"tags": [],
"label": "CspBenchmarksPage",
"description": [],
"signature": [
"\"rules\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/navigation.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CSPM_POLICY_TEMPLATE",
"type": "string",
"tags": [],
"label": "CSPM_POLICY_TEMPLATE",
"description": [],
"signature": [
"\"cspm\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspSetupStatus",
"type": "Type",
"tags": [],
"label": "CspSetupStatus",
"description": [],
"signature": [
{
"pluginId": "@kbn/cloud-security-posture-common",
"scope": "common",
"docId": "kibKbnCloudSecurityPostureCommonPluginApi",
"section": "def-common.BaseCspSetupStatus",
"text": "BaseCspSetupStatus"
}
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.CspStatusCode",
"type": "Type",
"tags": [],
"label": "CspStatusCode",
"description": [],
"signature": [
"\"indexed\" | \"indexing\" | \"unprivileged\" | \"index-timeout\" | \"not-deployed\" | \"not-installed\" | \"waiting_for_results\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.DETECTION_RULE_RULES_API_CURRENT_VERSION",
"type": "string",
"tags": [],
"label": "DETECTION_RULE_RULES_API_CURRENT_VERSION",
"description": [],
"signature": [
"\"2023-10-31\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.FINDINGS_INDEX_PATTERN",
"type": "string",
"tags": [],
"label": "FINDINGS_INDEX_PATTERN",
"description": [],
"signature": [
"\"logs-cloud_security_posture.findings-default*\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.IndexStatus",
"type": "Type",
"tags": [],
"label": "IndexStatus",
"description": [],
"signature": [
"\"empty\" | \"unprivileged\" | \"not-empty\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/status.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.KSPM_POLICY_TEMPLATE",
"type": "string",
"tags": [],
"label": "KSPM_POLICY_TEMPLATE",
"description": [],
"signature": [
"\"kspm\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.LATEST_FINDINGS_RETENTION_POLICY",
"type": "string",
"tags": [],
"label": "LATEST_FINDINGS_RETENTION_POLICY",
"description": [],
"signature": [
"\"26h\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.LATEST_VULNERABILITIES_RETENTION_POLICY",
"type": "string",
"tags": [],
"label": "LATEST_VULNERABILITIES_RETENTION_POLICY",
"description": [],
"signature": [
"\"3d\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.MAX_FINDINGS_TO_LOAD",
"type": "number",
"tags": [],
"label": "MAX_FINDINGS_TO_LOAD",
"description": [],
"signature": [
"500"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.MisconfigurationEvaluationStatus",
"type": "Type",
"tags": [],
"label": "MisconfigurationEvaluationStatus",
"description": [],
"signature": [
"\"unknown\" | \"failed\" | \"passed\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/misconfigurations.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.SECURITY_DEFAULT_DATA_VIEW_ID",
"type": "string",
"tags": [],
"label": "SECURITY_DEFAULT_DATA_VIEW_ID",
"description": [],
"signature": [
"\"security-solution-default\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.STATUS_API_CURRENT_VERSION",
"type": "string",
"tags": [],
"label": "STATUS_API_CURRENT_VERSION",
"description": [],
"signature": [
"\"1\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.STATUS_ROUTE_PATH",
"type": "string",
"tags": [],
"label": "STATUS_ROUTE_PATH",
"description": [],
"signature": [
"\"/internal/cloud_security_posture/status\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.VulnSeverity",
"type": "Type",
"tags": [],
"label": "VulnSeverity",
"description": [],
"signature": [
"\"MEDIUM\" | \"UNKNOWN\" | \"LOW\" | \"HIGH\" | \"CRITICAL\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/types/vulnerabilities.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.INTERNAL_FEATURE_FLAGS",
"type": "Object",
"tags": [],
"label": "INTERNAL_FEATURE_FLAGS",
"description": [],
"signature": [
"{ readonly showManageRulesMock: false; readonly showFindingFlyoutEvidence: true; }"
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.MISCONFIGURATION_STATUS",
"type": "Object",
"tags": [],
"label": "MISCONFIGURATION_STATUS",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.MISCONFIGURATION_STATUS.PASSED",
"type": "string",
"tags": [],
"label": "PASSED",
"description": [],
"signature": [
"\"passed\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.MISCONFIGURATION_STATUS.FAILED",
"type": "string",
"tags": [],
"label": "FAILED",
"description": [],
"signature": [
"\"failed\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.MISCONFIGURATION_STATUS.UNKNOWN",
"type": "string",
"tags": [],
"label": "UNKNOWN",
"description": [],
"signature": [
"\"unknown\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.VULNERABILITIES_SEVERITY",
"type": "Object",
"tags": [],
"label": "VULNERABILITIES_SEVERITY",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.VULNERABILITIES_SEVERITY.LOW",
"type": "string",
"tags": [],
"label": "LOW",
"description": [],
"signature": [
"\"LOW\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.VULNERABILITIES_SEVERITY.MEDIUM",
"type": "string",
"tags": [],
"label": "MEDIUM",
"description": [],
"signature": [
"\"MEDIUM\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.VULNERABILITIES_SEVERITY.HIGH",
"type": "string",
"tags": [],
"label": "HIGH",
"description": [],
"signature": [
"\"HIGH\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.VULNERABILITIES_SEVERITY.CRITICAL",
"type": "string",
"tags": [],
"label": "CRITICAL",
"description": [],
"signature": [
"\"CRITICAL\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/cloud-security-posture-common",
"id": "def-common.VULNERABILITIES_SEVERITY.UNKNOWN",
"type": "string",
"tags": [],
"label": "UNKNOWN",
"description": [],
"signature": [
"\"UNKNOWN\""
],
"path": "x-pack/platform/packages/shared/kbn-cloud-security-posture/common/constants.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
]
}
}