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

外部ユーザーの削除ジョブを送信

post
https://api.box.com/2.0
/external_users/submit_delete_job

現在のユーザーの企業から外部ユーザーを削除します。これにより、現在の企業内で招待されたすべてのコラボレーションから各外部ユーザーが削除されます。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header.

次の値に固定: 2025.0

リクエスト本文

object array本文内必須

削除する外部ユーザーのリスト。

string本文内必須
"12345"

ユーザーの一意の識別子。

string本文内必須
"user"

値は常にuserになります。

次の値に固定: user

レスポンス

application/json外部ユーザー削除ジョブ送信のレスポンス

各外部ユーザー削除リクエストの結果を含む複数のステータスのレスポンス。

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

リストの外部ユーザーが見つからない場合、または認証済みユーザーに外部ユーザーを削除するための適切な権限がない場合にエラーを返します。

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

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

post
外部ユーザーの削除ジョブを送信
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


Node/TypeScript v10
await client.externalUsers.submitJobToDeleteExternalUsersV2025R0({
  externalUsers: [
    new UserReferenceV2025R0({ id: getEnvVar('BOX_EXTERNAL_USER_ID') }),
  ],
} satisfies ExternalUsersSubmitDeleteJobRequestV2025R0);
Python v10
client.external_users.submit_job_to_delete_external_users_v2025_r0(
    [UserReferenceV2025R0(id=get_env_var("BOX_EXTERNAL_USER_ID"))]
)
.NET v10
await client.ExternalUsers.SubmitJobToDeleteExternalUsersV2025R0Async(requestBody: new ExternalUsersSubmitDeleteJobRequestV2025R0(externalUsers: Array.AsReadOnly(new [] {new UserReferenceV2025R0(id: Utils.GetEnvVar(name: "BOX_EXTERNAL_USER_ID"))})));
Swift v10
try await client.externalUsers.submitJobToDeleteExternalUsersV2025R0(requestBody: ExternalUsersSubmitDeleteJobRequestV2025R0(externalUsers: [UserReferenceV2025R0(id: Utils.getEnvironmentVariable(name: "BOX_EXTERNAL_USER_ID"))]))
Java v10
client.getExternalUsers().submitJobToDeleteExternalUsersV2025R0(new ExternalUsersSubmitDeleteJobRequestV2025R0(Arrays.asList(new UserReferenceV2025R0(getEnvVar("BOX_EXTERNAL_USER_ID")))))

レスポンスの例

{
  "entries": [
    {
      "status": 202,
      "user_id": "12345"
    }
  ]
}