ユーザーを更新
会社内の管理対象ユーザーを更新します。このエンドポイントを使用できるのは、適切な管理者権限を持つユーザーとアプリケーションのみです。
リクエスト
パスパラメータ
12345ユーザーのID。
クエリパラメータ
id,type,name応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。
リクエスト本文
900 Jefferson Ave, Redwood City, CA 94063255ユーザーの住所
trueユーザーが自身の連絡先リストで会社の他のユーザーを参照できるかどうか
これをnullに設定すると、ユーザーが会社のメンバーではなくなり、無料版ユーザーになります
true会社のデバイス制限からユーザーを除外するかどうか
trueユーザーが2要素認証を使用する必要があるかどうか
trueユーザーが社外のユーザーとのコラボレーションを許可されているかどうか
trueユーザーにパスワードのリセットを義務付けるかどうか
trueユーザーがBox Syncを使用できるかどうか
CEO100ユーザーの役職
boss@box.comユーザーがログインに使用するメールアドレス
Aaron Levie50ユーザーの名前
通知メールが送信される代替の通知用メールアドレス。確認されると、通知メールはプライマリメールアドレスではなくこのメールアドレスに送信されます。
これをnullに設定すると、通知メールが削除されます。
notifications@example.com通知を送付するメールアドレス。
trueユーザーが会社のメンバーでなくなった後もメールを受信できるようにするかどうか
6509241374100ユーザーの電話番号
userユーザーの会社ロール
次の値のいずれか1つ: coadmin,user
11345156112ユーザーが利用可能な容量の合計(バイト数)。これを-1に設定すると
ストレージ容量が無制限になります。
activeユーザーのアカウントのステータス
次の値のいずれか1つ: active,inactive,cannot_delete_edit,cannot_delete_edit_upload
Africa/Bujumburaユーザーのタイムゾーン
["code1: 12345"]追跡コードを使用すると、管理者は管理コンソールからレポートを生成し、特定のグループのユーザーに属性を割り当てることができます。この設定を使用するには、会社に対して有効にしておく必要があります。
レスポンス
更新されたユーザーオブジェクトを返します。
パラメータが不足しているか無効の場合はエラーを返します。
invalid_parameter: パラメータの形式が正しくない場合です。たとえば、notification_emailに正しくない形式のメールアドレスが含まれている場合です。
ユーザーに変更が許可されていない場合にエラーを返します。
access_denied_insufficient_permissions: ユーザーに適切な権限がない場合です。たとえば、企業の設定で通知メールのアップデートがオフになっている場合です。
予期しないクライアントエラー。
リクエストの例
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"
}'レスポンスの例
{
"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"
}