OpenID Connect logout API

リフレッシュトークンと、/_security/oidc/authenticateへの呼び出しに対する応答として生成されたアクセストークンを無効にするリクエストを送信します。

Request

POST /_security/oidc/logout

Description

ElasticsearchのOpenID Connect認証領域が適切に構成されている場合、この呼び出しに対する応答には、シングルログアウトを実行するためのOpenID Connectプロバイダーのエンドセッションエンドポイントを指すURIが含まれます。

Elasticsearchは、OpenID Connect APIを介して必要なすべてのOpenID Connect関連機能を公開しています。これらのAPIは、Kibanaによって内部的に使用され、OpenID Connectベースの認証を提供しますが、他のカスタムWebアプリケーションや他のクライアントでも使用できます。 OpenID Connect authenticate APIおよびOpenID Connect prepare authentication APIも参照してください。

Request body

  • access_token
  • （必須、文字列）ログアウトの一部として無効にされるアクセストークンの値。
  • refresh_token
  • （オプション、文字列）ログアウトの一部として無効にされるリフレッシュトークンの値。

Examples

以下の例はログアウトを実行します。

Python

  1. resp = client.security.oidc_logout(
  2.    body={
  3.    "token": "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==",
  4.    "refresh_token": "vLBPvmAB6KvwvJZr27cS"
  5.    },
  6. )
  7. print(resp)

Js

  1. const response = await client.security.oidcLogout({
  2.   body: {
  3.    token:
  4.    "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==",
  5.    refresh_token: "vLBPvmAB6KvwvJZr27cS",
  6.   },
  7. });
  8. console.log(response);

Console

  1. POST /_security/oidc/logout
  2. {
  3.   "token" : "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==",
  4.   "refresh_token": "vLBPvmAB6KvwvJZr27cS"
  5. }

以下の応答の例出力には、ログアウトリクエストのすべてのパラメータをHTTP GETパラメータとして含むOpenID Connectプロバイダーのエンドセッションエンドポイントを指すURIが含まれています:

Js

  1. {
  2.   "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"
  3. }