SAMLログアウトAPI

アクセストークンとリフレッシュトークンを無効にするリクエストを送信します。

このAPIは、Kibana以外のカスタムWebアプリケーションでの使用を目的としています。Kibanaを使用している場合は、Elastic StackでのSAMLシングルサインオンの設定を参照してください。

リクエスト

POST /_security/saml/logout

説明

このAPIは、SAML認証APIによってユーザーのために生成されたトークンを無効にします。

ElasticsearchのSAML領域が適切に構成されており、SAML IdPがこれをサポートしている場合、Elasticsearchの応答には、ユーザーをSAMLログアウトリクエストを含むIdPにリダイレクトするためのURLが含まれています（SP主導のSAMLシングルログアウトを開始します）。

Elasticsearchは、SAML APIを介して必要なすべてのSAML関連機能を公開しています。これらのAPIは、SAMLベースの認証を提供するためにKibanaによって内部的に使用されますが、他のカスタム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応答でSAML認証APIを呼び出すことによって生成されたトークンのペアを無効にします:

Python

  1. resp = client.security.saml_logout(
  2.    token="46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3",
  3.    refresh_token="mJdXLtmvTUSpoLwMvdBt_w",
  4. )
  5. print(resp)

Js

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

コンソール

  1. POST /_security/saml/logout
  2. {
  3.   "token" : "46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3",
  4.   "refresh_token" : "mJdXLtmvTUSpoLwMvdBt_w"
  5. }

APIは以下の応答を返します:

Js

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