ユーザーを更新

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

会社内の管理対象ユーザーを更新します。このエンドポイントを使用できるのは、適切な管理者権限を持つユーザーとアプリケーションのみです。

Request

Bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

ユーザーのID。

Query Parameters

string arrayin queryoptional
id,type,name

レスポンスに含める属性のカンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。

Request Body

stringin bodyoptional
900 Jefferson Ave, Redwood City, CA 94063255

ユーザーの住所

booleanin bodyoptional
true

ユーザーが自身の連絡先リストで会社の他のユーザーを参照できるかどうか

stringin bodyoptional

これをnullに設定すると、ユーザーが会社のメンバーではなくなり、無料版ユーザーになります

booleanin bodyoptional
true

会社のデバイス制限からユーザーを除外するかどうか

booleanin bodyoptional
true

ユーザーが2要素認証を使用する必要があるかどうか

booleanin bodyoptional
true

ユーザーが社外のユーザーとのコラボレーションを許可されているかどうか

booleanin bodyoptional
true

ユーザーにパスワードのリセットを義務付けるかどうか

booleanin bodyoptional
true

ユーザーがBox Syncを使用できるかどうか

stringin bodyoptional
CEO100

ユーザーの役職

stringin bodyoptional
en

修正版のISO 639-1形式で表されるユーザーの言語。

stringin bodyoptional
boss@box.com

ユーザーがログインに使用するメールアドレス

stringin bodyoptional
Aaron Levie50

ユーザーの名前

objectin body

通知メールが送信される代替の通知用メールアドレス。確認されると、通知メールはプライマリメールアドレスではなくこのメールアドレスに送信されます。

これをnullに設定すると、通知メールが削除されます。

stringin bodyoptional
notifications@example.com

通知を送付するメールアドレス。

booleanin bodyoptional
true

ユーザーが会社のメンバーでなくなった後もメールを受信できるようにするかどうか

stringin bodyoptional
6509241374100

ユーザーの電話番号

stringin bodyoptional
user

ユーザーの会社ロール

Value is one of coadmin,user

integer / int64in bodyoptional
11345156112

ユーザーが利用可能な容量の合計(バイト数)。これを-1に設定すると ストレージ容量が無制限になります。

stringin bodyoptional
active

ユーザーのアカウントのステータス

Value is one of active,inactive,cannot_delete_edit,cannot_delete_edit_upload

string / timezonein bodyoptional
Africa/Bujumbura

ユーザーのタイムゾーン

string arrayin bodyoptional
["code1: 12345"]

追跡コードを使用すると、管理者は管理コンソールからレポートを生成し、特定のグループのユーザーに属性を割り当てることができます。この設定を使用するには、会社に対して有効にしておく必要があります。

Response

application/jsonUser (Standard)

更新されたユーザーオブジェクトを返します。

パラメータが不足しているか無効の場合はエラーを返します。

  • invalid_parameter: パラメータの形式が正しくない場合です。たとえば、notification_emailに正しくない形式のメールアドレスが含まれている場合です。

ユーザーに変更が許可されていない場合にエラーを返します。

  • access_denied_insufficient_permissions: ユーザーに適切な権限がない場合です。たとえば、企業の設定で通知メールのアップデートがオフになっている場合です。

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

put
ユーザーを更新
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X PUT "https://api.box.com/2.0/users/12345" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "Aaron Levie"
     }'
.NET
var updates = new BoxUserRequest()
{
    Id = "44444",
    Role = "coadmin",
    CanSeeManagedUsers = true
};
BoxUser updatedUser = await client.UsersManager.UpdateUserInformationAsync(updates);
Java
BoxUser user = new BoxUser(api, "0");
BoxUser.Info info = user.new Info();
info.setName(name);
user.updateInfo(info);
Python
user_id = '33333'
user = client.user(user_id)
updated_user = user.update_info({'name': 'Smart User'})
Node
client.users.update('33333', {name: 'New Name', job_title: 'New Title', phone: '555-1111'})
    .then(user => {
        /* user -> {
            type: 'user',
            id: '33333',
            name: 'New Name',
            login: 'user@example.com',
            created_at: '2012-03-26T15:43:07-07:00',
            modified_at: '2012-12-12T11:34:29-08:00',
            language: 'en',
            space_amount: 5368709120,
            space_used: 2377016,
            max_upload_size: 262144000,
            status: 'active',
            job_title: 'New Title',
            phone: '555-1111',
            address: '555 Office Drive',
            avatar_url: 'https://app.box.com/api/avatar/deprecated' }
        */
    });
iOS
// Restrict the user from collaborating content externally
client.users.update(userId: "33333", isExternalCollabRestricted: true) { (result: Result<User, BoxSDKError>) in
    guard case let .success(user) = result else {
        print("Error updating user")
        return
    }

    print("Updated user \(user.name), with login \(user.login)")
}

Response Example

{
  "id": 11446498,
  "type": "user",
  "address": "900 Jefferson Ave, Redwood City, CA 94063",
  "avatar_url": "https://www.box.com/api/avatar/large/181216415",
  "created_at": "2012-12-12T10:53:43-08:00",
  "job_title": "CEO",
  "language": "en",
  "login": "ceo@example.com",
  "max_upload_size": 2147483648,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "name": "Aaron Levie",
  "notification_email": {
    "email": "notifications@example.com",
    "is_confirmed": true
  },
  "phone": 6509241374,
  "space_amount": 11345156112,
  "space_used": 1237009912,
  "status": "active",
  "timezone": "Africa/Bujumbura"
}