ユーザー強制ログアウト

POST /users/{userId}/force-logout

ユーザーを強制的にログアウトさせる。ブラウザ版、モバイル版アプリなどすべての接続が切断される。
強制ログアウトが適用されるまでに最大で 5 分ほど要する場合がある。

注意
ユーザー強制ログアウト API を呼び出すと、そのユーザーに発行された Access Token と Refresh Token は無効化される。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

directory
user

Request

HTTP Request

POST

https://www.worksapis.com/v1.0/users/{userId}/force-logout

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{userExternalKey})

required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 202

Accepted