Update User
Update a user by user ID. You must be a Box Administrator to perform this action.
Input
| Field | Definition | Type | Required |
|---|---|---|---|
| User ID |
Unique identifier of the user. |
String | TRUE |
| Address | Physical address of the user. | String | FALSE |
| Can See Managed Users | Indicates whether the user can see other enterprise users in their contact list. | Boolean | FALSE |
| Enterprise | Can be set to null to roll the user out of the enterprise and make them a free user. |
String | FALSE |
| Is Exempt From Device Limits | Indicates whether to exempt the user from enterprise device limits. | Boolean | FALSE |
| Is Exempt From Login Verification | Indicates whether the user must use two-factor authentication | Boolean | FALSE |
| Is External Collab Restricted | Indicates whether the user is allowed to collaborate with users outside their enterprise | Boolean | FALSE |
| Is Password Reset Required | Indicates whether the user is required to reset their password. | Boolean | FALSE |
| Is Sync Enabled | Indicates whether the user can use Box Sync. | Boolean | FALSE |
| Job Title | Job title of the user. | String | FALSE |
| Language | Language of the user, formatted in modified version of the ISO 639-1 format. | String | FALSE |
| Login | Email address of the user. | String | FALSE |
| Name |
Name of the user. |
String | FALSE |
| Notification Email | Alternate notification email address to which notifications are sent. When it's confirmed, this will be the email address to which notifications are sent instead of the primary email address. Set to null to remove notification email. |
String | FALSE |
| Notify | Indicates whether the user should receive an email when they are rolled out of an enterprise. | Boolean | FALSE |
| Phone | Phone number of the user. | String | FALSE |
| Role | Role of the user (user or co-admin). | Dropdown | FALSE |
| Space Amount (in Bytes) | Amount of space (in bytes) allotted to the user. | Number | FALSE |
| Status | Status of the user (for example, Active or Inactive). | Dropdown | FALSE |
| Timezone | Timezone of the user. | String | FALSE |
| Tracking Codes | Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. | String | FALSE |
Output
| Field | Definition | Type |
|---|---|---|
| User ID |
Unique identifier of the user. |
String |
| Address | Physical address of the user. | String |
| Avatar Url | URL of the user's avatar image. | String |
| Can See Managed Users | Indicates whether the user can see other enterprise users in their contact list. | Boolean |
| Created At |
Date and time when the object was created. |
Date & Time |
| Enterprise | Can be set to null to roll the user out of the enterprise and make them a free user. |
String |
| Is Exempt From Device Limits | Indicates whether to exempt the user from enterprise device limits. | Boolean |
| Is Exempt From Login Verification | Indicates whether the user must use two-factor authentication. | Boolean |
| Is External Collab Restricted | Indicates whether the user is allowed to collaborate with users outside their enterprise. | Boolean |
| Is Password Reset Required | Indicates whether the user is required to reset their password. | Boolean |
| Is Sync Enabled | Indicates whether the user can use Box Sync. | Boolean |
| Job Title | Job title of the user. | String |
| Language | Language of the user, formatted in modified version of the ISO 639-1 format. | String |
| Login | Email address of the user. | String |
| Max Upload Size (in bytes) | Maximum individual file size in bytes the user can upload. | String |
| Modified At | When the user object was last modified. | |
| Name |
Name of the user. |
String |
| Notification Email | Alternate notification email address to which notifications are sent. When it's confirmed, this will be the email address to which notifications are sent instead of the primary email address. Set to null to remove notification email. |
String |
| Phone | Phone number of the user. | String |
| Role | Role of the user (user or co-admin). | Dropdown |
| Space Amount (in Bytes) | Amount of space (in bytes) allotted to the user. | Number |
| Status | Status of the user (for example, Active or Inactive). | Dropdown |
| Timezone | Timezone of the user. | String |
| Tracking Codes | Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. | String |