ユーザーグループのセッションを終了させるジョブを作成
グループのロールと権限を検証し、グループのセッションを終了させる非同期ジョブを作成します。POSTリクエストのステータスを返します。
レスポンス
application/jsonセッション終了メッセージ
リクエストのステータスに関するメッセージを返します。
application/jsonクライアントエラー
一部のパラメータが無効な場合にエラーを返します。
Groups can not be NULL or EMPTY: 値が指定されていない場合group id format is string: 指定されたグループIDの形式が正しくな い場合Supported payload format is JSON: 指定されたペイロードの形式が正しくない場合
application/jsonクライアントエラー
権限が不足している場合にエラーを返します。
application/jsonクライアントエラー
リソースが見つからなかった場合にエラーを返します。
application/jsonクライアントエラー
リクエスト制限を超えた場合にエラーを返します。
application/jsonクライアントエラー
内部サーバーの問題が発生している場合にエラーを返します。
application/jsonクライアントエラー
リクエストがタイムアウトした場合にエラーを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X POST "https://api.box.com/2.0/groups/terminate_sessions" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-H "accept: application/json" \
-d
{
"group_ids": ["6178859178", "4824866571"],
}TypeScript Gen
await client.sessionTermination.terminateGroupsSessions({
groupIds: [group.id],
} satisfies TerminateGroupsSessionsRequestBody);Python Gen
client.session_termination.terminate_groups_sessions([group.id]).NET Gen
await client.SessionTermination.TerminateGroupsSessionsAsync(requestBody: new TerminateGroupsSessionsRequestBody(groupIds: Array.AsReadOnly(new [] {group.Id})));Node
var groupIDs = ['11111', '22222'];
client.groups.terminateSession(groupIDs)
.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"
}