Box Developerドキュメント
ログイン
最新バージョン

ユーザーのセッションを終了させるジョブを作成

post
https://api.box.com/2.0
/users/terminate_sessions

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

ユーザーのロールと権限を検証し、ユーザーのセッションを終了させる非同期ジョブを作成します。POSTリクエストのステータスを返します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエスト本文

string array本文内必須
["123456","456789"]

ユーザーIDのリスト。

string array本文内必須
["user@sample.com","user2@sample.com"]

A list of user logins.

レスポンス

application/jsonセッション終了メッセージ

リクエストのステータスに関するメッセージを返します。

application/jsonクライアントエラー

一部のパラメータが無効な場合にエラーを返します。

  • Users can not be NULL or EMPTY when no value is provided.
  • User id format is string when the provided user id format is incorrect.
  • Supported payload format is JSON when the provided payload format is incorrect.
application/jsonクライアントエラー

権限が不足している場合にエラーを返します。

application/jsonクライアントエラー

リソースが見つからなかった場合にエラーを返します。

application/jsonクライアントエラー

レート制限を超えた場合にエラーを返します。

application/jsonクライアントエラー

内部サーバーの問題が発生している場合にエラーを返します。

application/jsonクライアントエラー

リクエストがタイムアウトした場合にエラーを返します。

application/jsonクライアントエラー

予期しないクライアントエラー。

post
ユーザーのセッションを終了させるジョブを作成
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X POST "https://api.box.com/2.0/users/terminate_sessions" \
    -H "authorization: Bearer <ACCESS_TOKEN>" \
    -H "content-type: application/json" \
    -H "accept: application/json" \
    -d
  {
      user_ids: ["6178859178", "4824866571"]
      user_logins: ["user@example.com", "user2@example.com",]
  }
TypeScript Gen
await client.sessionTermination.terminateUsersSessions({
  userIds: [getEnvVar('USER_ID')],
  userLogins: [user.login!],
} satisfies TerminateUsersSessionsRequestBody);
Python Gen
client.session_termination.terminate_users_sessions(
    [get_env_var("USER_ID")], [user.login]
)
.NET Gen
await client.SessionTermination.TerminateUsersSessionsAsync(requestBody: new TerminateUsersSessionsRequestBody(userIds: Array.AsReadOnly(new [] {Utils.GetEnvVar("USER_ID")}), userLogins: Array.AsReadOnly(new [] {NullableUtils.Unwrap(user.Login)})));
Node
var userIDs = ['33333', '44444'];
var userLogins = ['user1@example.com', 'user2@example.com'];

client.users.terminateSession({
    user_ids: userIDs,
    user_logins: userLogins
}).then((result) => {
        /* result -> {
            message: "Request is successful, please check the admin events for the status of the job" }
        */
    });

レスポンスの例

{
  "message": "Request is successful, please check the admin\nevents for the status of the job"
}