Box Developer Documentation
Log in

Delete User

Guides Users Delete User
Edit this page

Delete User

The process for deleting both app and managed users is the same. To delete a user account, supply the user ID for the account that should be removed.

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);
Swift Gen (Beta)
try await client.users.deleteUserById(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")
}

There are also two optional parameters that may be set when deleting a user account:

  • force: Whether the user should be deleted even if the account still has content in it.
  • notify: Whether the user will receive a notification that the account was deleted.

The delete user request will fail if the user account still has content in it. To resolve this, either transfer all files or folders to another account or use the optional force parameter.