› › ›

SAML 注销 API

编辑

SAML 注销 API

编辑

提交请求以使访问令牌和刷新令牌失效。

此 API 旨在供 Kibana 以外的自定义 Web 应用程序使用。如果您正在使用 Kibana，请参阅在 Elastic Stack 上配置 SAML 单点登录。

请求

编辑

POST /_security/saml/logout

描述

编辑

此 API 使由 SAML 认证 API为用户生成的令牌失效。

如果 Elasticsearch 中的 SAML 领域已相应配置，并且 SAML IdP 支持此功能，则 Elasticsearch 响应将包含一个 URL，用于将用户重定向到 IdP，其中包含 SAML 注销请求（启动 SP 发起的 SAML 单点注销）。

Elasticsearch 通过 SAML API 公开所有必要的 SAML 相关功能。这些 API 在内部被 Kibana 用来提供基于 SAML 的身份验证，但也可能被其他自定义 Web 应用程序或其他客户端使用。另请参阅 SAML 认证 API，SAML 准备认证 API，SAML 失效 API 和 SAML 完成注销 API。

请求体

编辑

token: （必需，字符串）作为调用 SAML 认证 API 的响应返回的访问令牌。或者，通过使用 refresh_token 刷新原始令牌后收到的最新令牌。
refresh_token: （可选，字符串）作为调用 SAML 认证 API 的响应返回的刷新令牌。或者，在刷新原始访问令牌后收到的最新刷新令牌。

响应体

编辑

redirect: （字符串）一个 URL，其中包含作为参数的 SAML 注销请求。用户可以使用此 URL 重定向回 SAML IdP 并启动单点注销。

示例

编辑

以下示例使通过使用成功的 SAML 响应调用 SAML 认证 API 生成的一对令牌失效

resp = client.security.saml_logout(
    token="46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3",
    refresh_token="mJdXLtmvTUSpoLwMvdBt_w",
)
print(resp)

const response = await client.security.samlLogout({
  token: "46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3",
  refresh_token: "mJdXLtmvTUSpoLwMvdBt_w",
});
console.log(response);

POST /_security/saml/logout
{
  "token" : "46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3",
  "refresh_token" : "mJdXLtmvTUSpoLwMvdBt_w"
}

该 API 返回以下响应

{
  "redirect" : "https://my-idp.org/logout/SAMLRequest=...."
}

« SAML 认证 API SAML 失效 API »