OpenID Connect 注销 API

编辑

提交请求以使刷新令牌和访问令牌失效,这些令牌是对调用 /_security/oidc/authenticate 的响应而生成的。

请求

编辑

POST /_security/oidc/logout

描述

编辑

如果 Elasticsearch 中的 OpenID Connect 身份验证领域已相应配置,则对此调用的响应将包含一个指向 OpenID Connect 提供商的会话结束端点的 URI,以执行单点注销。

Elasticsearch 通过 OpenID Connect API 公开所有必要的 OpenID Connect 相关功能。这些 API 在内部由 Kibana 使用,以提供基于 OpenID Connect 的身份验证,但也可以由其他自定义 Web 应用程序或其他客户端使用。另请参阅 OpenID Connect 认证 APIOpenID Connect 准备身份验证 API

请求体

编辑
access_token
(必需,字符串)作为注销的一部分要失效的访问令牌的值。
refresh_token
(可选,字符串)作为注销的一部分要失效的刷新令牌的值。

示例

编辑

以下示例执行注销

resp = client.security.oidc_logout(
    body={
        "token": "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==",
        "refresh_token": "vLBPvmAB6KvwvJZr27cS"
    },
)
print(resp)
const response = await client.security.oidcLogout({
  body: {
    token:
      "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==",
    refresh_token: "vLBPvmAB6KvwvJZr27cS",
  },
});
console.log(response);
POST /_security/oidc/logout
{
  "token" : "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==",
  "refresh_token": "vLBPvmAB6KvwvJZr27cS"
}

以下示例响应的输出包含一个指向 OpenID Connect 提供商的会话结束端点的 URI,其中包含注销请求的所有参数,作为 HTTP GET 参数

{
  "redirect" : "https://op-provider.org/logout?id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c&post_logout_redirect_uri=http%3A%2F%2Foidc-kibana.elastic.co%2Floggedout&state=lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO"
}