设置案例配置 API
编辑设置案例配置 API编辑
设置外部连接详细信息,例如案例的关闭类型和默认连接器。
有关最新 API 详细信息,请参阅 开放 API 规范。
先决条件编辑
您必须对 案例 功能在 管理、可观察性 或 安全 部分具有 所有
权限,具体取决于案例配置的 所有者
。请参阅 Kibana 功能权限。
描述编辑
连接器用于与外部系统交互。您必须先创建连接器,然后才能在案例中使用它。请参阅 添加连接器。
如果您设置了默认连接器,它会在您在 Kibana 中创建案例时自动选择。但是,如果您使用 创建案例 API,则仍然必须指定所有连接器详细信息。
路径参数编辑
-
<空间 ID>
- (可选,字符串) 空间的标识符。如果未指定,则使用默认空间。
请求正文编辑
-
closure_type
-
(必需,字符串) 指定案例在推送到外部系统时是否自动关闭。
有效值为
-
close-by-pushing
:案例在推送时自动关闭。 -
close-by-user
:案例不会自动关闭。
-
-
connector
-
(必需,对象) 包含连接器配置的对象。
connector
的属性-
fields
-
(必需,对象) 包含连接器字段的对象。
案例配置中指定的字段不会被使用,也不会传播到各个案例,因此建议将其设置为
null
。 -
id
- (必需,字符串) 连接器的标识符。如果您不希望使用默认连接器,请使用
none
。要检索连接器 ID,请使用 查找连接器。 -
name
- (必需,字符串) 连接器的名称。如果您不希望使用默认连接器,请使用
none
。要检索连接器名称,请使用 查找连接器。 -
type
- (必需,字符串) 连接器的类型。有效值为:
.cases-webhook
、.jira
、.none
、.resilient
、.servicenow
、.servicenow-sir
和.swimlane
。
-
-
owner
- (必需,字符串) 拥有案例配置的应用程序。有效值为:
cases
、observability
或securitySolution
。此值会影响您是为堆栈管理、可观察性还是 Elastic 安全应用程序设置案例配置详细信息。 -
settings
-
(可选,对象) 包含案例设置的对象。
settings
的属性-
syncAlerts
- (必需,布尔值) 打开或关闭警报同步。
-
响应代码编辑
-
200
- 表示成功调用。
示例编辑
为 堆栈管理 中的案例设置关闭类型和默认连接器
POST api/cases/configure { "owner": "cases", "connector": { "id": "5e656730-e1ca-11ec-be9b-9b1838238ee6", "name": "my-jira-connector", "type": ".jira", "fields": null, }, "closure_type": "close-by-user" }
API 返回以下响应
{ "closure_type": "close-by-user", "owner": "cases", "created_at": "2022-06-01T17:07:17.767Z", "created_by": { "username": "elastic", "email": null, "full_name": null }, "updated_at": null, "updated_by": null, "connector": { "id": "5e656730-e1ca-11ec-be9b-9b1838238ee6", "name": "my-jira-connector", "type": ".jira", "fields": null }, "mappings": [ { "source": "title", "target": "summary", "action_type": "overwrite" }, { "source": "description", "target": "description", "action_type": "overwrite" }, { "source": "comments", "target": "comments", "action_type": "append" } ], "version": "WzIwNzMsMV0=", "error": null, "id": "4a97a440-e1cd-11ec-be9b-9b1838238ee6" }