SAML 注销 API
编辑SAML 注销 API
编辑提交请求以使访问令牌和刷新令牌失效。
此 API 旨在供 Kibana 以外的自定义 Web 应用程序使用。如果您使用的是 Kibana，请参阅在 Elastic Stack 上配置 SAML 单点登录。
请求
编辑POST /_security/saml/logout
描述
编辑此 API 使由SAML 认证 API为用户生成的令牌失效。
如果 Elasticsearch 中的 SAML 域已相应配置，并且 SAML IdP 支持此功能，则 Elasticsearch 响应包含一个 URL，用于将用户重定向到包含 SAML 注销请求的 IdP（启动 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 - （字符串）包含 SAML 注销请求作为参数的 URL。用户可以使用此 URL 重定向回 SAML IdP 并启动单点注销。
示例
编辑以下示例使通过调用SAML 认证 API并获得成功的 SAML 响应而生成的一对令牌失效
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=...."
}