kibana/x-pack/plugins/cases

Case management in Kibana

Cases Plugin Docs

Report Bug · Request Feature

Table of Contents

• Cases API
• Cases Client API
• Cases UI
• Case Action Type feature in development, disabled by default

Cases API

Explore the API docs »

Cases Client API

Cases Client API docs

Cases UI

Embed Cases UI components in any Kibana plugin

• Add CasesUiStart to Kibana plugin StartServices dependencies:

cases: CasesUiStart;

Cases UI Methods

• From the UI component, get the component from the useKibana hook start services

  const { cases } = useKibana().services;
  // call in the return as you would any component
  cases.getCreateCase({
    onCancel: handleSetIsCancel,
    onSuccess,
    timelineIntegration?: {
      plugins: {
        parsingPlugin,
        processingPluginRenderer,
        uiPlugin,
      },
      hooks: {
        useInsertTimeline,
      },
    },
  })

Methods:

getAllCases

Arguments:

Property	Description
caseDetailsNavigation	CasesNavigation<CaseDetailsHrefSchema, 'configurable'> route configuration to generate the case details url for the case details page
configureCasesNavigation	CasesNavigation route configuration for configure cases page
createCaseNavigation	CasesNavigation route configuration for create cases page
userCanCrud	boolean; user permissions to crud

UI component:

getAllCasesSelectorModal

Arguments:

Property	Description
alertData?	Omit<CommentRequestAlertType, 'type'>; alert data to post to case
createCaseNavigation	CasesNavigation route configuration for create cases page
hiddenStatuses?	CaseStatuses[]; array of hidden statuses
onRowClick	(theCase?: Case | SubCase) => void; callback for row click, passing case in row
updateCase?	(theCase: Case | SubCase) => void; callback after case has been updated
userCanCrud	boolean; user permissions to crud

UI component:

getCaseView

Arguments:

Property	Description
caseDetailsNavigation	CasesNavigation<CaseDetailsHrefSchema, 'configurable'> route configuration to generate the case details url for the case details page
caseId	string; ID of the case
configureCasesNavigation	CasesNavigation route configuration for configure cases page
createCaseNavigation	CasesNavigation route configuration for create cases page
getCaseDetailHrefWithCommentId	(commentId: string) => string; callback to generate the case details url with a comment id reference from the case id and comment id
onComponentInitialized?	() => void; callback when component has initialized
onCaseDataSuccess?	(data: Case) => void; optional callback to handle case data in consuming application
ruleDetailsNavigation	CasesNavigation<string | null | undefined, 'configurable'>
showAlertDetails	(alertId: string, index: string) => void; callback to show alert details
subCaseId?	string; subcase id
timelineIntegration?.editor_plugins	Plugins needed for integrating timeline into markdown editor.
timelineIntegration?.editor_plugins.parsingPlugin	Plugin;
timelineIntegration?.editor_plugins.processingPluginRenderer	React.FC<TimelineProcessingPluginRendererProps & { position: EuiMarkdownAstNodePosition }>
timelineIntegration?.editor_plugins.uiPlugin?	EuiMarkdownEditorUiPlugin
timelineIntegration?.hooks.useInsertTimeline	(value: string, onChange: (newValue: string) => void): UseInsertTimelineReturn
timelineIntegration?.ui?.renderInvestigateInTimelineActionComponent?	(alertIds: string[]) => JSX.Element; space to render InvestigateInTimelineActionComponent
timelineIntegration?.ui?renderTimelineDetailsPanel?	() => JSX.Element; space to render TimelineDetailsPanel
useFetchAlertData	(alertIds: string[]) => [boolean, Record<string, Ecs>]; fetch alerts
userCanCrud	boolean; user permissions to crud

UI component:

getCreateCase

Arguments:

Property	Description
afterCaseCreated?	(theCase: Case) => Promise<void>; callback passing newly created case before pushCaseToExternalService is called
onCancel	() => void; callback when create case is canceled
onSuccess	(theCase: Case) => Promise<void>; callback passing newly created case after pushCaseToExternalService is called
timelineIntegration?.editor_plugins	Plugins needed for integrating timeline into markdown editor.
timelineIntegration?.editor_plugins.parsingPlugin	Plugin;
timelineIntegration?.editor_plugins.processingPluginRenderer	React.FC<TimelineProcessingPluginRendererProps & { position: EuiMarkdownAstNodePosition }>
timelineIntegration?.editor_plugins.uiPlugin?	EuiMarkdownEditorUiPlugin
timelineIntegration?.hooks.useInsertTimeline	(value: string, onChange: (newValue: string) => void): UseInsertTimelineReturn

UI component:

getConfigureCases

Arguments:

Property	Description
userCanCrud	boolean; user permissions to crud

UI component:

getRecentCases

Arguments:

Property	Description
allCasesNavigation	CasesNavigation route configuration for configure cases page
caseDetailsNavigation	CasesNavigation<CaseDetailsHrefSchema, 'configurable'> route configuration to generate the case details url for the case details page
createCaseNavigation	CasesNavigation route configuration for create case page
maxCasesToShow	number; number of cases to show in widget

UI component:

Case Action Type

*Feature in development, disabled by default

See Kibana Actions for more information.

ID: .case

The params properties are modelled after the arguments to the Cases API.

config

This action has no config properties.

secrets

This action type has no secrets properties.

params

Property	Description	Type
subAction	The sub action to perform. It can be create, update, and addComment	string
subActionParams	The parameters of the sub action	object

subActionParams (create)

Property	Description	Type
tile	The case’s title.	string
description	The case’s description.	string
tags	String array containing words and phrases that help categorize cases.	string[]
connector	Object containing the connector’s configuration.	connector
settings	Object containing the case’s settings.	settings

subActionParams (update)

Property	Description	Type
id	The ID of the case being updated.	string
tile	The updated case title.	string
description	The updated case description.	string
tags	The updated case tags.	string
connector	Object containing the connector’s configuration.	connector
status	The updated case status, which can be: open, in-progress or closed.	string
settings	Object containing the case’s settings.	settings
version	The current case version.	string

subActionParams (addComment)

Property	Description	Type
type	The type of the comment.	user
comment	The comment.	string

connector

Property	Description	Type
id	ID of the connector used for pushing case updates to external systems.	string
name	The connector name.	string
type	The type of the connector. Must be one of these: .servicenow, .servicenow-sir, .swimlane, jira, .resilient, and .none	string
fields	Object containing the connector’s fields.	fields

fields

For ServiceNow connectors:

Property	Description	Type
urgency	The urgency of the incident.	string
severity	The severity of the incident.	string
impact	The impact of the incident.	string

For Jira connectors:

Property	Description	Type
issueType	The issue type of the issue.	string
priority	The priority of the issue.	string
parent	The key of the parent issue (Valid when the issue type is Sub-task).	string

For IBM Resilient connectors:

Property	Description	Type
issueTypes	The issue types of the issue.	string[]
severityCode	The severity code of the issue.	string

settings

Property	Description	Type
syncAlerts	Turn on or off alert synching.	boolean