ユーザーを削除

delete
https://api.box.com/2.0
/users/:user_id/

ユーザーを削除します。デフォルトでは、ユーザーがまだコンテンツを所有している状態では失敗します。削除を実行する前にユーザーが所有するコンテンツを移動するか、forceフィールドを使用してユーザーとそのユーザーが所有するファイルを削除してください。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

ユーザーのID。

クエリパラメータ

booleanクエリ内省略可能
true

まだファイルを所有していてもこのユーザーを削除するかどうか

booleanクエリ内省略可能
true

削除に関するメール通知がユーザーに送信されるかどうか

レスポンス

none

ユーザーを削除して空の応答を返します。

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

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

リクエストの例

cURL
curl -i -X DELETE "https://api.box.com/2.0/users/12345" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
await client.UsersManager.DeleteEnterpriseUserAsync("44444", notify: false, force: true);
Java
BoxUser user = new BoxUser(api, "0");
user.delete(false, false);
Python
user_id = '33333'
client.user(user_id).delete(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")
}