kibana/api_docs/cases.devdocs.json

3820 lines
No EOL
194 KiB
JSON

{
"id": "cases",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "cases",
"id": "def-public.generateCaseViewPath",
"type": "Function",
"tags": [],
"label": "generateCaseViewPath",
"description": [],
"signature": [
"(params: ",
"CaseViewPathParams",
") => string"
],
"path": "x-pack/platform/plugins/shared/cases/public/common/navigation/paths.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.generateCaseViewPath.$1",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
"CaseViewPathParams"
],
"path": "x-pack/platform/plugins/shared/cases/public/common/navigation/paths.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-public.getCasesDeepLinks",
"type": "Function",
"tags": [],
"label": "getCasesDeepLinks",
"description": [],
"signature": [
"<T extends ",
"AppDeepLink",
"<string> = ",
"AppDeepLink",
"<string>>({ basePath, extend, }: { basePath?: string | undefined; extend?: Partial<Record<",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.ICasesDeepLinkId",
"text": "ICasesDeepLinkId"
},
", Partial<T>>> | undefined; }) => { id: \"cases\"; path: string; deepLinks: ({ id: \"cases_create\"; path: string; title: string; keywords?: T[\"keywords\"] | undefined; visibleIn?: T[\"visibleIn\"] | undefined; category?: T[\"category\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; deepLinks?: T[\"deepLinks\"] | undefined; } | { id: \"cases_configure\"; path: string; title: string; keywords?: T[\"keywords\"] | undefined; visibleIn?: T[\"visibleIn\"] | undefined; category?: T[\"category\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; deepLinks?: T[\"deepLinks\"] | undefined; })[]; title: string; keywords?: T[\"keywords\"] | undefined; visibleIn?: T[\"visibleIn\"] | undefined; category?: T[\"category\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; }"
],
"path": "x-pack/platform/plugins/shared/cases/public/common/navigation/deep_links.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.getCasesDeepLinks.$1",
"type": "Object",
"tags": [],
"label": "{\n basePath = DEFAULT_BASE_PATH,\n extend = {},\n}",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/public/common/navigation/deep_links.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.getCasesDeepLinks.$1.basePath",
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/cases/public/common/navigation/deep_links.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-public.getCasesDeepLinks.$1.extend",
"type": "Object",
"tags": [],
"label": "extend",
"description": [],
"signature": [
"Partial<Record<",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.ICasesDeepLinkId",
"text": "ICasesDeepLinkId"
},
", Partial<T>>> | undefined"
],
"path": "x-pack/platform/plugins/shared/cases/public/common/navigation/deep_links.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "cases",
"id": "def-public.CaseAttachments",
"type": "Type",
"tags": [],
"label": "CaseAttachments",
"description": [],
"signature": [
"SupportedCaseAttachment",
"[]"
],
"path": "x-pack/platform/plugins/shared/cases/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-public.CaseAttachmentsWithoutOwner",
"type": "Type",
"tags": [],
"label": "CaseAttachmentsWithoutOwner",
"description": [],
"signature": [
"CaseAttachmentWithoutOwner",
"[]"
],
"path": "x-pack/platform/plugins/shared/cases/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-public.DRAFT_COMMENT_STORAGE_ID",
"type": "string",
"tags": [],
"label": "DRAFT_COMMENT_STORAGE_ID",
"description": [],
"signature": [
"\"xpack.cases.commentDraft\""
],
"path": "x-pack/platform/plugins/shared/cases/public/components/markdown_editor/plugins/lens/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-public.GetAllCasesSelectorModalProps",
"type": "Type",
"tags": [],
"label": "GetAllCasesSelectorModalProps",
"description": [],
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; owner: string[]; permissions: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; basePath?: string | undefined; releasePhase?: ",
"ReleasePhase",
" | undefined; hiddenStatuses?: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[] | undefined; onRowClick?: ((theCase?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseUI",
"text": "CaseUI"
},
" | undefined) => void) | undefined; onClose?: ((theCase?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseUI",
"text": "CaseUI"
},
" | undefined, isCreateCase?: boolean | undefined) => void) | undefined; onCreateCaseClicked?: (() => void) | undefined; }"
],
"path": "x-pack/platform/plugins/shared/cases/public/client/ui/get_all_cases_selector_modal.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-public.GetCreateCaseFlyoutProps",
"type": "Type",
"tags": [],
"label": "GetCreateCaseFlyoutProps",
"description": [],
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; owner: string[]; permissions: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; basePath?: string | undefined; releasePhase?: ",
"ReleasePhase",
" | undefined; onClose?: (() => void) | undefined; attachments?: ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.CaseAttachmentsWithoutOwner",
"text": "CaseAttachmentsWithoutOwner"
},
" | undefined; afterCaseCreated?: ((theCase: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseUI",
"text": "CaseUI"
},
", createAttachments: ",
"UseMutateFunction",
"<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseUI",
"text": "CaseUI"
},
", ",
"ServerError",
", ",
"PostComment",
", unknown>) => Promise<void>) | undefined; onSuccess?: ((theCase: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseUI",
"text": "CaseUI"
},
") => void) | undefined; headerContent?: React.ReactNode; initialValue?: Pick<{ description: string; tags: string[]; title: string; connector: { id: string; } & (({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: ({ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: ({ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; } & { name: string; })); settings: { syncAlerts: boolean; }; owner: string; } & { assignees?: { uid: string; }[] | undefined; severity?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
" | undefined; category?: string | null | undefined; customFields?: ({ key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[] | undefined; }, \"title\" | \"description\"> | undefined; }"
],
"path": "x-pack/platform/plugins/shared/cases/public/client/ui/get_create_case_flyout.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-public.GetRecentCasesProps",
"type": "Type",
"tags": [],
"label": "GetRecentCasesProps",
"description": [],
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; owner: string[]; permissions: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; basePath?: string | undefined; releasePhase?: ",
"ReleasePhase",
" | undefined; maxCasesToShow: number; }"
],
"path": "x-pack/platform/plugins/shared/cases/public/client/ui/get_recent_cases.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-public.ICasesDeepLinkId",
"type": "Type",
"tags": [],
"label": "ICasesDeepLinkId",
"description": [],
"signature": [
"\"cases\" | \"cases_create\" | \"cases_configure\""
],
"path": "x-pack/platform/plugins/shared/cases/public/common/navigation/deep_links.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "cases",
"id": "def-public.CasesDeepLinkId",
"type": "Object",
"tags": [],
"label": "CasesDeepLinkId",
"description": [],
"signature": [
"{ readonly cases: \"cases\"; readonly casesCreate: \"cases_create\"; readonly casesConfigure: \"cases_configure\"; }"
],
"path": "x-pack/platform/plugins/shared/cases/public/common/navigation/deep_links.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"start": {
"parentPluginId": "cases",
"id": "def-public.CasesPublicStart",
"type": "Interface",
"tags": [],
"label": "CasesPublicStart",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.CasesPublicStart.api",
"type": "Object",
"tags": [],
"label": "api",
"description": [],
"signature": [
"{ getRelatedCases: (alertId: string, query: { owner?: string | string[] | undefined; }) => Promise<{ id: string; title: string; description: string; status: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; createdAt: string; totals: { alerts: number; userComments: number; }; }[]>; cases: { find: (query: { tags?: string | string[] | undefined; status?: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"[] | undefined; severity?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
" | ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
"[] | undefined; assignees?: string | string[] | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; from?: string | undefined; search?: string | undefined; searchFields?: \"title\" | \"description\" | (\"title\" | \"description\")[] | undefined; sortField?: \"title\" | \"createdAt\" | \"updatedAt\" | \"status\" | \"severity\" | \"category\" | \"closedAt\" | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; category?: string | string[] | undefined; } & Partial<",
"Pagination",
">, signal?: AbortSignal | undefined) => Promise<",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesFindResponseUI",
"text": "CasesFindResponseUI"
},
">; getCasesMetrics: (query: { features: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseMetricsFeature",
"text": "CaseMetricsFeature"
},
"[]; } & { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ mttr?: number | null | undefined; status?: { open: number; inProgress: number; closed: number; } | undefined; }>; bulkGet: (params: { ids: string[]; }, signal?: AbortSignal | undefined) => Promise<{ cases: ({ description: string; tags: string[]; title: string; connector: { id: string; } & (({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: ({ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: ({ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; } & { name: string; })); severity: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
"; assignees: { uid: string; }[]; category: string | null; customFields: ({ key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: ({ id: string; createdAt: string; updatedAt: string | null; } & { typeKey: string; value: string; description: string | null; })[]; status: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; owner: string; } & { duration: number | null; closed_at: string | null; closed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; external_service: ({ connector_id: string; } & { connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: ((({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | (({ externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; })) & { id: string; version: string; })[] | undefined; })[]; errors: { error: string; message: string; status: number | undefined; caseId: string; }[]; }>; }; }"
],
"path": "x-pack/platform/plugins/shared/cases/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-public.CasesPublicStart.ui",
"type": "Object",
"tags": [],
"label": "ui",
"description": [],
"signature": [
"{ getCases: (props: ",
"GetCasesProps",
") => React.ReactElement<",
"GetCasesProps",
", string | React.JSXElementConstructor<any>>; getCasesContext: () => React.FC<React.PropsWithChildren<",
"GetCasesContextProps",
">>; getAllCasesSelectorModal: (props: ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.GetAllCasesSelectorModalProps",
"text": "GetAllCasesSelectorModalProps"
},
") => React.ReactElement<",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.GetAllCasesSelectorModalProps",
"text": "GetAllCasesSelectorModalProps"
},
", string | React.JSXElementConstructor<any>>; getRecentCases: (props: ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.GetRecentCasesProps",
"text": "GetRecentCasesProps"
},
") => React.ReactElement<",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.GetRecentCasesProps",
"text": "GetRecentCasesProps"
},
", string | React.JSXElementConstructor<any>>; }"
],
"path": "x-pack/platform/plugins/shared/cases/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-public.CasesPublicStart.hooks",
"type": "Object",
"tags": [],
"label": "hooks",
"description": [],
"signature": [
"{ useCasesAddToNewCaseFlyout: ({ initialValue, toastTitle, toastContent, afterCaseCreated, onSuccess, onClose, }?: AddToNewCaseFlyoutProps) => { open: ({ attachments, headerContent, }?: { attachments?: ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.CaseAttachmentsWithoutOwner",
"text": "CaseAttachmentsWithoutOwner"
},
" | undefined; headerContent?: React.ReactNode; }) => void; close: () => void; }; useCasesAddToExistingCaseModal: ({ successToaster, noAttachmentsToaster, onSuccess, onClose, onCreateCaseClicked, }?: ",
"AddToExistingCaseModalProps",
") => { open: ({ getAttachments, }?: { getAttachments?: (({ theCase }: { theCase?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseUI",
"text": "CaseUI"
},
" | undefined; }) => ",
{
"pluginId": "cases",
"scope": "public",
"docId": "kibCasesPluginApi",
"section": "def-public.CaseAttachmentsWithoutOwner",
"text": "CaseAttachmentsWithoutOwner"
},
") | undefined; }) => void; close: () => void; }; useIsAddToCaseOpen: ",
"UseIsAddToCaseOpen",
"; }"
],
"path": "x-pack/platform/plugins/shared/cases/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-public.CasesPublicStart.helpers",
"type": "Object",
"tags": [],
"label": "helpers",
"description": [],
"signature": [
"{ canUseCases: (owners?: ",
"CasesOwners",
"[]) => ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; getUICapabilities: (featureCapabilities?: Partial<Record<string, boolean | Record<string, boolean>>> | undefined) => ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; getRuleIdFromEvent: (event: Event) => { id: string; name: string; }; groupAlertsByRule: ",
"GroupAlertsByRule",
"; }"
],
"path": "x-pack/platform/plugins/shared/cases/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"parentPluginId": "cases",
"id": "def-public.CasesPublicSetup",
"type": "Interface",
"tags": [],
"label": "CasesPublicSetup",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-public.CasesPublicSetup.attachmentFramework",
"type": "Object",
"tags": [],
"label": "attachmentFramework",
"description": [],
"signature": [
"AttachmentFramework"
],
"path": "x-pack/platform/plugins/shared/cases/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient",
"type": "Class",
"tags": [],
"label": "CasesClient",
"description": [
"\nClient wrapper that contains accessor methods for individual entities within the cases system."
],
"path": "x-pack/platform/plugins/shared/cases/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/shared/cases/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"CasesClientArgs"
],
"path": "x-pack/platform/plugins/shared/cases/server/client/client.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.cases",
"type": "Object",
"tags": [],
"label": "cases",
"description": [
"\nRetrieves an interface for interacting with cases entities."
],
"signature": [
"CasesSubClient"
],
"path": "x-pack/platform/plugins/shared/cases/server/client/client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.attachments",
"type": "Object",
"tags": [],
"label": "attachments",
"description": [
"\nRetrieves an interface for interacting with attachments (comments) entities."
],
"signature": [
"AttachmentsSubClient"
],
"path": "x-pack/platform/plugins/shared/cases/server/client/client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.userActions",
"type": "Object",
"tags": [],
"label": "userActions",
"description": [
"\nRetrieves an interface for interacting with the user actions associated with the plugin entities."
],
"signature": [
"UserActionsSubClient"
],
"path": "x-pack/platform/plugins/shared/cases/server/client/client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.configure",
"type": "Object",
"tags": [],
"label": "configure",
"description": [
"\nRetrieves an interface for interacting with the configuration of external connectors for the plugin entities."
],
"signature": [
"ConfigureSubClient"
],
"path": "x-pack/platform/plugins/shared/cases/server/client/client.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-server.CasesClient.metrics",
"type": "Object",
"tags": [],
"label": "metrics",
"description": [
"\nRetrieves an interface for retrieving metrics related to the cases entities."
],
"signature": [
"MetricsSubClient"
],
"path": "x-pack/platform/plugins/shared/cases/server/client/client.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "cases",
"id": "def-server.CasesServerSetup",
"type": "Interface",
"tags": [],
"label": "CasesServerSetup",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesServerSetup.attachmentFramework",
"type": "Object",
"tags": [],
"label": "attachmentFramework",
"description": [],
"signature": [
"AttachmentFramework"
],
"path": "x-pack/platform/plugins/shared/cases/server/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "cases",
"id": "def-server.CasesServerStart",
"type": "Interface",
"tags": [],
"label": "CasesServerStart",
"description": [
"\nCases server exposed contract for interacting with cases entities."
],
"path": "x-pack/platform/plugins/shared/cases/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesServerStart.getCasesClientWithRequest",
"type": "Function",
"tags": [],
"label": "getCasesClientWithRequest",
"description": [
"\nReturns a client which can be used to interact with the cases backend entities.\n"
],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => Promise<",
{
"pluginId": "cases",
"scope": "server",
"docId": "kibCasesPluginApi",
"section": "def-server.CasesClient",
"text": "CasesClient"
},
">"
],
"path": "x-pack/platform/plugins/shared/cases/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-server.CasesServerStart.getCasesClientWithRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [
"a KibanaRequest"
],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/plugins/shared/cases/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"a {@link CasesClient }"
]
},
{
"parentPluginId": "cases",
"id": "def-server.CasesServerStart.getExternalReferenceAttachmentTypeRegistry",
"type": "Function",
"tags": [],
"label": "getExternalReferenceAttachmentTypeRegistry",
"description": [],
"signature": [
"() => ",
"ExternalReferenceAttachmentTypeRegistry"
],
"path": "x-pack/platform/plugins/shared/cases/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "cases",
"id": "def-server.CasesServerStart.getPersistableStateAttachmentTypeRegistry",
"type": "Function",
"tags": [],
"label": "getPersistableStateAttachmentTypeRegistry",
"description": [],
"signature": [
"() => ",
"PersistableStateAttachmentTypeRegistry"
],
"path": "x-pack/platform/plugins/shared/cases/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "cases",
"id": "def-common.createUICapabilities",
"type": "Function",
"tags": [],
"label": "createUICapabilities",
"description": [
"\nReturn the UI capabilities for each type of operation. These strings must match the values defined in the UI\nhere: x-pack/platform/plugins/shared/cases/public/client/helpers/capabilities.ts"
],
"signature": [
"() => ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesUiCapabilities",
"text": "CasesUiCapabilities"
}
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getApiTags",
"type": "Function",
"tags": [],
"label": "getApiTags",
"description": [],
"signature": [
"(owner: \"cases\" | \"observability\" | \"securitySolution\") => ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesApiTags",
"text": "CasesApiTags"
}
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getApiTags.$1",
"type": "CompoundType",
"tags": [],
"label": "owner",
"description": [],
"signature": [
"\"cases\" | \"observability\" | \"securitySolution\""
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getCaseFindUserActionsUrl",
"type": "Function",
"tags": [],
"label": "getCaseFindUserActionsUrl",
"description": [],
"signature": [
"(id: string) => string"
],
"path": "x-pack/platform/plugins/shared/cases/common/api/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getCaseFindUserActionsUrl.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/cases/common/api/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getCasesFromAlertsUrl",
"type": "Function",
"tags": [],
"label": "getCasesFromAlertsUrl",
"description": [],
"signature": [
"(alertId: string) => string"
],
"path": "x-pack/platform/plugins/shared/cases/common/api/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.getCasesFromAlertsUrl.$1",
"type": "string",
"tags": [],
"label": "alertId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/cases/common/api/helpers.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.throwErrors",
"type": "Function",
"tags": [],
"label": "throwErrors",
"description": [],
"signature": [
"(createError: ErrorFactory) => (errors: ",
"Errors",
") => never"
],
"path": "x-pack/platform/plugins/shared/cases/common/api/runtime_types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.throwErrors.$1",
"type": "Function",
"tags": [],
"label": "createError",
"description": [],
"signature": [
"ErrorFactory"
],
"path": "x-pack/platform/plugins/shared/cases/common/api/runtime_types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "cases",
"id": "def-common.CasesApiTags",
"type": "Interface",
"tags": [],
"label": "CasesApiTags",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CasesApiTags.all",
"type": "Object",
"tags": [],
"label": "all",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesApiTags.read",
"type": "Object",
"tags": [],
"label": "read",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesApiTags.delete",
"type": "Object",
"tags": [],
"label": "delete",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesApiTags.createComment",
"type": "Object",
"tags": [],
"label": "createComment",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/api_tags.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities",
"type": "Interface",
"tags": [],
"label": "CasesCapabilities",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities.CREATE_CASES_CAPABILITY",
"type": "boolean",
"tags": [],
"label": "[CREATE_CASES_CAPABILITY]",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities.READ_CASES_CAPABILITY",
"type": "boolean",
"tags": [],
"label": "[READ_CASES_CAPABILITY]",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities.UPDATE_CASES_CAPABILITY",
"type": "boolean",
"tags": [],
"label": "[UPDATE_CASES_CAPABILITY]",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities.DELETE_CASES_CAPABILITY",
"type": "boolean",
"tags": [],
"label": "[DELETE_CASES_CAPABILITY]",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities.PUSH_CASES_CAPABILITY",
"type": "boolean",
"tags": [],
"label": "[PUSH_CASES_CAPABILITY]",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities.CASES_CONNECTORS_CAPABILITY",
"type": "boolean",
"tags": [],
"label": "[CASES_CONNECTORS_CAPABILITY]",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities.CASES_SETTINGS_CAPABILITY",
"type": "boolean",
"tags": [],
"label": "[CASES_SETTINGS_CAPABILITY]",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities.CREATE_COMMENT_CAPABILITY",
"type": "boolean",
"tags": [],
"label": "[CREATE_COMMENT_CAPABILITY]",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities.CASES_REOPEN_CAPABILITY",
"type": "boolean",
"tags": [],
"label": "[CASES_REOPEN_CAPABILITY]",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesCapabilities.ASSIGN_CASE_CAPABILITY",
"type": "boolean",
"tags": [],
"label": "[ASSIGN_CASE_CAPABILITY]",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions",
"type": "Interface",
"tags": [],
"label": "CasesPermissions",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.all",
"type": "boolean",
"tags": [],
"label": "all",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.create",
"type": "boolean",
"tags": [],
"label": "create",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.read",
"type": "boolean",
"tags": [],
"label": "read",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.update",
"type": "boolean",
"tags": [],
"label": "update",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.delete",
"type": "boolean",
"tags": [],
"label": "delete",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.push",
"type": "boolean",
"tags": [],
"label": "push",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.connectors",
"type": "boolean",
"tags": [],
"label": "connectors",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.settings",
"type": "boolean",
"tags": [],
"label": "settings",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.reopenCase",
"type": "boolean",
"tags": [],
"label": "reopenCase",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.createComment",
"type": "boolean",
"tags": [],
"label": "createComment",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.assign",
"type": "boolean",
"tags": [],
"label": "assign",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities",
"type": "Interface",
"tags": [],
"label": "CasesUiCapabilities",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities.all",
"type": "Object",
"tags": [],
"label": "all",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities.read",
"type": "Object",
"tags": [],
"label": "read",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities.delete",
"type": "Object",
"tags": [],
"label": "delete",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities.settings",
"type": "Object",
"tags": [],
"label": "settings",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities.reopenCase",
"type": "Object",
"tags": [],
"label": "reopenCase",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities.createComment",
"type": "Object",
"tags": [],
"label": "createComment",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUiCapabilities.assignCase",
"type": "Object",
"tags": [],
"label": "assignCase",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/utils/capabilities.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.Ecs",
"type": "Interface",
"tags": [],
"label": "Ecs",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.Ecs._id",
"type": "string",
"tags": [],
"label": "_id",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.Ecs._index",
"type": "string",
"tags": [],
"label": "_index",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.Ecs.signal",
"type": "Object",
"tags": [],
"label": "signal",
"description": [],
"signature": [
"SignalEcs",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "cases",
"id": "def-common.Ecs.kibana",
"type": "Object",
"tags": [],
"label": "kibana",
"description": [],
"signature": [
"{ alert: ",
"SignalEcsAAD",
"; } | undefined"
],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "cases",
"id": "def-common.AttachmentType",
"type": "Enum",
"tags": [],
"label": "AttachmentType",
"description": [
"\nUser comment"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/domain/attachment/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseMetricsFeature",
"type": "Enum",
"tags": [],
"label": "CaseMetricsFeature",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/types/api/metrics/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseSeverity",
"type": "Enum",
"tags": [],
"label": "CaseSeverity",
"description": [
"\nSeverity"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/domain/case/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ConnectorTypes",
"type": "Enum",
"tags": [],
"label": "ConnectorTypes",
"description": [],
"path": "x-pack/platform/plugins/shared/cases/common/types/domain/connector/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ExternalReferenceStorageType",
"type": "Enum",
"tags": [],
"label": "ExternalReferenceStorageType",
"description": [
"\nExternal reference"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/domain/attachment/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "cases",
"id": "def-common.APP_ID",
"type": "string",
"tags": [],
"label": "APP_ID",
"description": [
"\nApplication"
],
"signature": [
"\"cases\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/application.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.ASSIGN_CASE_CAPABILITY",
"type": "string",
"tags": [],
"label": "ASSIGN_CASE_CAPABILITY",
"description": [],
"signature": [
"\"cases_assign\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.AttachmentAttributes",
"type": "Type",
"tags": [],
"label": "AttachmentAttributes",
"description": [],
"signature": [
"({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | (({ externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; })"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/domain/attachment/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.Case",
"type": "Type",
"tags": [],
"label": "Case",
"description": [],
"signature": [
"{ description: string; tags: string[]; title: string; connector: { id: string; } & (({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: ({ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: ({ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; } & { name: string; })); severity: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
"; assignees: { uid: string; }[]; category: string | null; customFields: ({ key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: ({ id: string; createdAt: string; updatedAt: string | null; } & { typeKey: string; value: string; description: string | null; })[]; status: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; owner: string; } & { duration: number | null; closed_at: string | null; closed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; external_service: ({ connector_id: string; } & { connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: ((({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | (({ externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; })) & { id: string; version: string; })[] | undefined; }"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/domain/case/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASE_COMMENT_SAVED_OBJECT",
"type": "string",
"tags": [],
"label": "CASE_COMMENT_SAVED_OBJECT",
"description": [],
"signature": [
"\"cases-comments\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasePatchRequest",
"type": "Type",
"tags": [],
"label": "CasePatchRequest",
"description": [],
"signature": [
"{ description?: string | undefined; tags?: string[] | undefined; title?: string | undefined; connector?: ({ id: string; } & (({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: ({ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: ({ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; } & { name: string; }))) | undefined; severity?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
" | undefined; assignees?: { uid: string; }[] | undefined; category?: string | null | undefined; customFields?: ({ key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[] | undefined; settings?: { syncAlerts: boolean; } | undefined; } & { status?: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; owner?: string | undefined; } & { id: string; version: string; }"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/api/case/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasePostRequest",
"type": "Type",
"tags": [],
"label": "CasePostRequest",
"description": [],
"signature": [
"{ description: string; tags: string[]; title: string; connector: { id: string; } & (({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: ({ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: ({ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; } & { name: string; })); settings: { syncAlerts: boolean; }; owner: string; } & { assignees?: { uid: string; }[] | undefined; severity?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
" | undefined; category?: string | null | undefined; customFields?: ({ key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[] | undefined; }"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/api/case/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.Cases",
"type": "Type",
"tags": [],
"label": "Cases",
"description": [],
"signature": [
"({ description: string; tags: string[]; title: string; connector: { id: string; } & (({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: ({ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: ({ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; } & { name: string; })); severity: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
"; assignees: { uid: string; }[]; category: string | null; customFields: ({ key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: ({ id: string; createdAt: string; updatedAt: string | null; } & { typeKey: string; value: string; description: string | null; })[]; status: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; owner: string; } & { duration: number | null; closed_at: string | null; closed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; external_service: ({ connector_id: string; } & { connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: ((({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | (({ externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; })) & { id: string; version: string; })[] | undefined; })[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/domain/case/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASES_CONNECTORS_CAPABILITY",
"type": "string",
"tags": [],
"label": "CASES_CONNECTORS_CAPABILITY",
"description": [],
"signature": [
"\"cases_connectors\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASES_REOPEN_CAPABILITY",
"type": "string",
"tags": [],
"label": "CASES_REOPEN_CAPABILITY",
"description": [],
"signature": [
"\"case_reopen\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASES_SETTINGS_CAPABILITY",
"type": "string",
"tags": [],
"label": "CASES_SETTINGS_CAPABILITY",
"description": [],
"signature": [
"\"cases_settings\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CASES_URL",
"type": "string",
"tags": [],
"label": "CASES_URL",
"description": [
"\nCase routes"
],
"signature": [
"\"/api/cases\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesBulkGetResponse",
"type": "Type",
"tags": [],
"label": "CasesBulkGetResponse",
"description": [],
"signature": [
"{ cases: ({ description: string; tags: string[]; title: string; connector: { id: string; } & (({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: ({ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: ({ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; } & { name: string; })); severity: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
"; assignees: { uid: string; }[]; category: string | null; customFields: ({ key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: ({ id: string; createdAt: string; updatedAt: string | null; } & { typeKey: string; value: string; description: string | null; })[]; status: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; owner: string; } & { duration: number | null; closed_at: string | null; closed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; external_service: ({ connector_id: string; } & { connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: ((({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | (({ externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; })) & { id: string; version: string; })[] | undefined; })[]; errors: { error: string; message: string; status: number | undefined; caseId: string; }[]; }"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/api/case/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesFindResponseUI",
"type": "Type",
"tags": [],
"label": "CasesFindResponseUI",
"description": [],
"signature": [
"Omit<{ cases: { description: string; tags: string[]; title: string; connector: { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; additionalFields?: string | null | undefined; } | null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; additionalFields?: string | null | undefined; } | null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; name: string; }; severity: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
"; assignees: { uid: string; }[]; category: string | null; customFields: ({ key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: { id: string; createdAt: string; updatedAt: string | null; typeKey: string; value: string; description: string | null; }[]; status: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; owner: string; duration: number | null; closedAt: string | null; closedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; externalService: { connectorId: string; connectorName: string; externalId: string; externalTitle: string; externalUrl: string; pushedAt: string; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; totalComment: number; totalAlerts: number; version: string; comments?: ({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".user; owner: string; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | any | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | any | null; } | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | any | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | any | null; } | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | any | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | any | null; } | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; }; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; })[] | undefined; }[]; page: number; perPage: number; total: number; countOpenCases: number; countInProgressCases: number; countClosedCases: number; }, \"cases\"> & { cases: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesUI",
"text": "CasesUI"
},
"; }"
],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesMetricsResponse",
"type": "Type",
"tags": [],
"label": "CasesMetricsResponse",
"description": [],
"signature": [
"{ mttr?: number | null | undefined; status?: { open: number; inProgress: number; closed: number; } | undefined; }"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/api/metrics/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesUI",
"type": "Type",
"tags": [],
"label": "CasesUI",
"description": [],
"signature": [
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseUI",
"text": "CaseUI"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseUI",
"type": "Type",
"tags": [],
"label": "CaseUI",
"description": [],
"signature": [
"Omit<{ description: string; tags: string[]; title: string; connector: { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; additionalFields?: string | null | undefined; } | null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; additionalFields?: string | null | undefined; } | null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; name: string; } | { id: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; name: string; }; severity: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
"; assignees: { uid: string; }[]; category: string | null; customFields: ({ key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[]; settings: { syncAlerts: boolean; }; observables: { id: string; createdAt: string; updatedAt: string | null; typeKey: string; value: string; description: string | null; }[]; status: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; owner: string; duration: number | null; closedAt: string | null; closedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; externalService: { connectorId: string; connectorName: string; externalId: string; externalTitle: string; externalUrl: string; pushedAt: string; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; totalComment: number; totalAlerts: number; version: string; comments?: ({ comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".user; owner: string; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | any | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | any | null; } | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | any | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | any | null; } | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | (string | number | boolean | any | any | null)[] | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | (string | number | boolean | any | any | null)[] | null; } | (string | number | boolean | { [x: string]: string | number | boolean | any | any | null; } | any | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null)[] | null; }; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; pushedAt: string | null; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; version: string; })[] | undefined; }, \"comments\"> & { comments: ",
"AttachmentUI",
"[]; }"
],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CaseViewRefreshPropInterface",
"type": "Type",
"tags": [],
"label": "CaseViewRefreshPropInterface",
"description": [
"\nThe type for the `refreshRef` prop (a `React.Ref`) defined by the `CaseViewComponentProps`.\n"
],
"signature": [
"{ refreshCase: () => Promise<void>; } | null"
],
"path": "x-pack/platform/plugins/shared/cases/common/ui/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CREATE_CASES_CAPABILITY",
"type": "string",
"tags": [],
"label": "CREATE_CASES_CAPABILITY",
"description": [
"\nCases UI Capabilities"
],
"signature": [
"\"create_cases\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CREATE_COMMENT_CAPABILITY",
"type": "string",
"tags": [],
"label": "CREATE_COMMENT_CAPABILITY",
"description": [],
"signature": [
"\"create_comment\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.DELETE_CASES_CAPABILITY",
"type": "string",
"tags": [],
"label": "DELETE_CASES_CAPABILITY",
"description": [],
"signature": [
"\"delete_cases\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.FEATURE_ID",
"type": "string",
"tags": [
"deprecated"
],
"label": "FEATURE_ID",
"description": [],
"signature": [
"\"generalCases\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/application.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "ml",
"path": "x-pack/platform/plugins/shared/ml/public/application/explorer/alerts/alerts_panel.tsx"
},
{
"plugin": "ml",
"path": "x-pack/platform/plugins/shared/ml/public/application/explorer/alerts/alerts_panel.tsx"
},
{
"plugin": "ml",
"path": "x-pack/platform/plugins/shared/ml/public/application/explorer/alerts/alerts_panel.tsx"
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.FEATURE_ID_V2",
"type": "string",
"tags": [
"deprecated"
],
"label": "FEATURE_ID_V2",
"description": [],
"signature": [
"\"generalCasesV2\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/application.ts",
"deprecated": true,
"trackAdoption": false,
"references": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.GENERAL_CASES_OWNER",
"type": "string",
"tags": [],
"label": "GENERAL_CASES_OWNER",
"description": [],
"signature": [
"\"cases\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/owners.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.GET_CONNECTORS_CONFIGURE_API_TAG",
"type": "string",
"tags": [],
"label": "GET_CONNECTORS_CONFIGURE_API_TAG",
"description": [
"\nThis tag is registered for the connectors (configure) get API"
],
"signature": [
"\"casesGetConnectorsConfigure\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.GetRelatedCasesByAlertResponse",
"type": "Type",
"tags": [],
"label": "GetRelatedCasesByAlertResponse",
"description": [],
"signature": [
"{ id: string; title: string; description: string; status: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; createdAt: string; totals: { alerts: number; userComments: number; }; }[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/api/case/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.INTERNAL_BULK_CREATE_ATTACHMENTS_URL",
"type": "string",
"tags": [],
"label": "INTERNAL_BULK_CREATE_ATTACHMENTS_URL",
"description": [],
"signature": [
"\"/internal/cases/{case_id}/attachments/_bulk_create\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.INTERNAL_BULK_GET_CASES_URL",
"type": "string",
"tags": [],
"label": "INTERNAL_BULK_GET_CASES_URL",
"description": [],
"signature": [
"\"/internal/cases/_bulk_get\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.LENS_ATTACHMENT_TYPE",
"type": "string",
"tags": [],
"label": "LENS_ATTACHMENT_TYPE",
"description": [],
"signature": [
"\".lens\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/visualizations.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.OBSERVABILITY_OWNER",
"type": "string",
"tags": [],
"label": "OBSERVABILITY_OWNER",
"description": [],
"signature": [
"\"observability\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/owners.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.PUSH_CASES_CAPABILITY",
"type": "string",
"tags": [],
"label": "PUSH_CASES_CAPABILITY",
"description": [],
"signature": [
"\"push_cases\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.READ_CASES_CAPABILITY",
"type": "string",
"tags": [],
"label": "READ_CASES_CAPABILITY",
"description": [],
"signature": [
"\"read_cases\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.RelatedCase",
"type": "Type",
"tags": [],
"label": "RelatedCase",
"description": [],
"signature": [
"{ id: string; title: string; description: string; status: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; createdAt: string; totals: { alerts: number; userComments: number; }; }"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/domain/case/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SAVED_OBJECT_TYPES",
"type": "Array",
"tags": [],
"label": "SAVED_OBJECT_TYPES",
"description": [
"\nIf more values are added here please also add them here: x-pack/test/cases_api_integration/common/plugins"
],
"signature": [
"(\"cases\" | \"cases-connector-mappings\" | \"cases-user-actions\" | \"cases-comments\" | \"cases-configure\")[]"
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SECURITY_SOLUTION_OWNER",
"type": "string",
"tags": [],
"label": "SECURITY_SOLUTION_OWNER",
"description": [
"\nOwner"
],
"signature": [
"\"securitySolution\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/owners.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SingleCaseMetricsResponse",
"type": "Type",
"tags": [],
"label": "SingleCaseMetricsResponse",
"description": [],
"signature": [
"{ alerts?: { count?: number | undefined; hosts?: { total: number; values: { name: string | undefined; id: string; count: number; }[]; } | undefined; users?: { total: number; values: { name: string; count: number; }[]; } | undefined; } | undefined; connectors?: { total: number; } | undefined; actions?: { isolateHost?: { isolate: { total: number; }; unisolate: { total: number; }; } | undefined; } | undefined; lifespan?: { creationDate: string; closeDate: string | null; statusInfo: { openDuration: number; inProgressDuration: number; reopenDates: string[]; }; } | undefined; }"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/api/metrics/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.UPDATE_CASES_CAPABILITY",
"type": "string",
"tags": [],
"label": "UPDATE_CASES_CAPABILITY",
"description": [],
"signature": [
"\"update_cases\""
],
"path": "x-pack/platform/plugins/shared/cases/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.UserActionFindResponse",
"type": "Type",
"tags": [],
"label": "UserActionFindResponse",
"description": [],
"signature": [
"{ userActions: (((({ type: \"description\"; payload: { description: string; }; } | { type: \"tags\"; payload: { tags: string[]; }; } | { type: \"title\"; payload: { title: string; }; } | { type: \"settings\"; payload: { settings: { syncAlerts: boolean; }; }; } | { type: \"status\"; payload: { status: ",
{
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; }; } | { type: \"severity\"; payload: { severity: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseSeverity",
"text": "CaseSeverity"
},
"; }; } | { type: \"assignees\"; payload: { assignees: { uid: string; }[]; }; } | { type: \"delete_case\"; payload: {}; } | { type: \"category\"; payload: { category: string | null; }; } | { type: \"customFields\"; payload: { customFields: ({ key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[]; }; } | { type: \"comment\"; payload: { comment: { comment: string; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".user; owner: string; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ExternalReferenceStorageType",
"text": "ExternalReferenceStorageType"
},
".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".externalReference; owner: string; } | { type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.AttachmentType",
"text": "AttachmentType"
},
".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.JsonValue",
"text": "JsonValue"
},
"; }; }; }; } | ({ type: \"create_case\"; } & { payload: { connector: { id: string; } & (({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: ({ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: ({ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; } & { name: string; })); } & { assignees: { uid: string; }[]; description: string; status: string; severity: string; tags: string[]; title: string; settings: { syncAlerts: boolean; }; owner: string; } & { category?: string | null | undefined; customFields?: ({ key: string; type: ",
"CustomFieldTypes",
".TEXT; value: string | null; } | { key: string; type: ",
"CustomFieldTypes",
".TOGGLE; value: boolean | null; } | { key: string; type: ",
"CustomFieldTypes",
".NUMBER; value: number | null; })[] | undefined; }; }) | { type: \"connector\"; payload: { connector: { id: string; } & (({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".casesWebhook; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".none; fields: null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowITSM; fields: ({ impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".serviceNowSIR; fields: ({ category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } & { additionalFields?: string | null | undefined; }) | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".swimlane; fields: { caseId: string | null; } | null; } & { name: string; }) | ({ type: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.ConnectorTypes",
"text": "ConnectorTypes"
},
".theHive; fields: { tlp: number | null; } | null; } & { name: string; })); }; } | { type: \"pushed\"; payload: { externalService: { connector_id: string; } & { connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; }; }; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; action: \"create\" | \"update\" | \"delete\" | \"add\" | \"push_to_service\"; }) & { comment_id: string | null; }) & { id: string; version: string; })[]; page: number; perPage: number; total: number; }"
],
"path": "x-pack/platform/plugins/shared/cases/common/types/api/user_action/v1.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}