Box Developerドキュメント

ユーザーの削除

ガイド ユーザー ユーザーの削除

ユーザーの削除

App Userと管理対象ユーザーの削除プロセスは同じです。ユーザーアカウントを削除するには、削除するアカウントのユーザーIDを指定します。

cURL
curl -i -X DELETE "https://api.box.com/2.0/users/12345" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.users.deleteUserById(createdUser.id);
Python Gen
client.users.delete_user_by_id(created_user.id)
.NET Gen
await client.Users.DeleteUserByIdAsync(userId: createdUser.Id);
Java
BoxUser user = new BoxUser(api, "0");
user.delete(false, false);
Python
user_id = '33333'
client.user(user_id).delete(force=True)
.NET
await client.UsersManager.DeleteEnterpriseUserAsync("44444", notify: false, force: true);
Node
// Delete the user even if they still have files in their account
client.users.delete('123', {force: true})
    .then(() => {
        // deletion succeeded — no value returned
    });
iOS
client.users.rollOutOfEnterprise(userId: "33333") { (result: Result<User, BoxSDKError>) in
    guard case let .success(user) = result else {
        print("Error removing user from enterprise")
        return
    }

    print("User \(user.name) successfully removed from enterprise")
}

ユーザーアカウントを削除するときに設定できるオプションパラメータも2つあります。

  • force: アカウントにまだコンテンツがある場合でも、ユーザーを削除するかどうか。
  • notify: アカウントが削除されたという通知をユーザーに送信するかどうか。

ユーザーアカウントにまだコンテンツがある場合、ユーザー削除リクエストは失敗します。これを解決するには、別のアカウントにすべてのファイルまたはフォルダを転送するか、オプションのforceパラメータを使用します。