使用户会话失效 API编辑

[预览] 此功能处于技术预览阶段,可能会在未来版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能支持 SLA 的约束。 使与提供的查询匹配的用户会话失效。

先决条件编辑

要使用使用户会话失效 API,您必须是 超级用户

请求编辑

POST <kibana 主机>:<端口>/api/security/session/_invalidate

请求正文编辑

match
(必填,字符串)指定 Kibana 如何确定要使哪些会话失效。可以是 all 以使所有现有会话失效,也可以是 query 以仅使与附加 query 参数中指定的查询匹配的会话失效。
query

(可选,对象)指定当 match 参数设置为 query 时,Kibana 用于匹配要使之失效的会话的查询。如果 match 设置为 all,则不能使用此参数。

query 的属性
provider

(必填,对象)描述要为其使会话失效的身份验证提供程序

type
(必填,字符串)身份验证提供程序 类型
name
(可选,字符串)身份验证提供程序 名称
username
(可选,字符串)要为其使会话失效的用户名。

响应正文编辑

total
(数字)已成功失效的会话数。

响应代码编辑

200
表示调用成功。
403
表示用户可能无权使其他用户的会话失效。请参阅先决条件

示例编辑

使所有现有会话失效

$ curl -X POST api/security/session/_invalidate
{
  "match" : "all"
}

使由任何SAML 身份验证提供程序创建的会话失效

$ curl -X POST api/security/session/_invalidate
{
  "match" : "query",
  "query": {
    "provider" : { "type": "saml" }
  }
}

使由名称为 saml1SAML 身份验证提供程序创建的会话失效

$ curl -X POST api/security/session/_invalidate
{
  "match" : "query",
  "query": {
    "provider" : { "type": "saml", "name": "saml1" }
  }
}

使由任何OpenID Connect 身份验证提供程序为用户名为 [email protected] 的用户创建的会话失效

$ curl -X POST api/security/session/_invalidate
{
  "match" : "query",
  "query": {
    "provider" : { "type": "oidc" },
    "username": "[email protected]"
  }
}