ユーザーを更新
企業内の管理対象ユーザーまたはApp Userを更新します。このエンドポイントを使用できるのは、適切な管理者権限を持つユーザーとアプリケーションのみです。
リクエスト
パスパラメータ
12345ユーザーのID。
クエリパラメータ
id,type,nameレスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
リクエスト本文
"900 Jefferson Ave, Redwood City, CA 94063"255ユーザーの住所。
trueユーザーが自身の連絡先リストで企業の他のユーザーを参照できるかどうか。
これをnullに設定すると、ユーザーが企業のメンバーではなくなり、無料ユーザーになります。
"my-user-1234"ユーザーの検索に使用できる、App Userの外部識別子。これを使用して、外部IDプロバイダのユーザーIDをBoxユーザーに結び付けることができます。
注: このフィールドを更新するには、App Userを作成したアプリケーションを使用してトークンをリクエストする必要があります。
true企業のデバイス制限からユーザーを除外するかどうか。
trueユーザーが2要素認証を使用する必要があるかどうか。
trueユーザーが社外のユーザーとのコラボレーションを許可されているかどうか。
trueユーザーにパスワードのリセットを義務付けるかどうか。
trueユーザーがBox Syncを使用できるかどうか。
"CEO"100ユーザーの役職。
"somename@box.com"ユーザーがログインに使用するメールアドレス
注: ターゲットユーザーのメールアドレスが確認されていない場合は、プライマリログインアドレスを変更できません。
"Aaron Levie"50ユーザーの名前。
通知メールが送信される代替の通知用メールアドレス。確認されると、通知メールはプライマリメールアドレスではなくこのメールアドレスに送信されます。
これをnullに設定すると、通知メールが削除されます。
"notifications@example.com"通知を送付するメールアドレス。
trueユーザーが企業のメンバーでなくなった後もメールを受信できるようにするかどうか。
"6509241374"100ユーザーの電話番号。
"user"ユーザーの企業でのロール。
次の値のいずれか1つ: coadmin,user
11345156112ユーザーが利用可能な容量の合計 (バイト数)。これを-1に設定するとストレージ容量が無制限になります。
"active"ユーザーのアカウントのステータス。
次の値のいずれか1つ: active,inactive,cannot_delete_edit,cannot_delete_edit_upload
"Africa/Bujumbura"ユーザーのタイムゾーン。
追跡コードを使用すると、管理者は管理コンソールからレポートを生成し、特定のグループのユーザーに属性を割り当てることができます。この設定を使用するには、会社に対して有効にしておく必要があります。
"tracking_code"値は常にtracking_codeになります。
次の値に固定: tracking_code
"department"追跡コードの名前。管理コンソールであらかじめ設定しておく必要があります。
"Sales"追跡コードの値。
レスポンス
更新されたユーザーオブジェクトを返します。
パラメータが不足しているか無効の場合はエラーを返します。
invalid_parameter: パラメータの形式が正しくない場合です。たとえば、notification_emailに正しくない形式のメールアドレスが含まれている場合です。
ユーザーに変更が許可されていない場合にエラーを返します。
access_denied_insufficient_permissions: ユーザーに適切な権限がない場合です。たとえば、企業の設定で通知メールのアップデートがオフになっている場合です 。denied_by_policy: 情報バリアの制限によりユーザーに適切な権限がない場合。
予期しないクライアントエラー。
リクエストの例
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"
}'await client.users.updateUserById(user.id, {
requestBody: { name: updatedUserName } satisfies UpdateUserByIdRequestBody,
} satisfies UpdateUserByIdOptionalsInput);client.users.update_user_by_id(user.id, name=updated_user_name)await client.Users.UpdateUserByIdAsync(userId: user.Id, requestBody: new UpdateUserByIdRequestBody() { Name = updatedUserName });try await client.users.updateUserById(userId: user.id, requestBody: UpdateUserByIdRequestBody(name: updatedUserName))client.getUsers().updateUserById(user.getId(), new UpdateUserByIdRequestBody.Builder().name(updatedUserName).build())await client.Users.UpdateUserByIdAsync(userId: user.Id, requestBody: new UpdateUserByIdRequestBody() { Name = updatedUserName });await client.users.updateUserById(user.id, {
requestBody: { name: updatedUserName } satisfies UpdateUserByIdRequestBody,
} satisfies UpdateUserByIdOptionalsInput);レスポンスの例
{
"id": "11446498",
"type": "user",
"address": "900 Jefferson Ave, Redwood City, CA 94063",
"avatar_url": "https://www.box.com/api/avatar/large/181216415",
"can_see_managed_users": true,
"created_at": "2012-12-12T10:53:43-08:00",
"enterprise": {
"id": "11446498",
"type": "enterprise",
"name": "Acme Inc."
},
"external_app_user_id": "my-user-1234",
"hostname": "https://example.app.box.com/",
"is_exempt_from_device_limits": true,
"is_exempt_from_login_verification": true,
"is_external_collab_restricted": true,
"is_platform_access_only": true,
"is_sync_enabled": true,
"job_title": "CEO",
"language": "en",
"login": "ceo@example.com",
"max_upload_size": 2147483648,
"modified_at": "2012-12-12T10:53:43-08:00",
"my_tags": [
"important"
],
"name": "Aaron Levie",
"notification_email": {
"email": "notifications@example.com",
"is_confirmed": true
},
"phone": "6509241374",
"role": "admin",
"space_amount": 11345156112,
"space_used": 1237009912,
"status": "active",
"timezone": "Africa/Bujumbura",
"tracking_codes": [
{
"name": "department",
"type": "tracking_code",
"value": "Sales"
}
]
}