Update user - Box Dev Docs

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

user_id

string

required

The ID of the user.

Query Parameters

fields

string[]

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Body

application/json

enterprise

string | null

Set this to null to roll the user out of the enterprise and make them a free user.

Example:

null

notify

boolean

Whether the user should receive an email when they are rolled out of an enterprise.

Example:

true

name

string

The name of the user.

Maximum string length: 50

Example:

"Aaron Levie"

The email address the user uses to log in

Note: If the target user's email is not confirmed, then the primary login address cannot be changed.

Example:

"[email protected]"

role

enum<string>

The user’s enterprise role.

Available options:

coadmin,

user

Example:

"user"

language

string

The language of the user, formatted in modified version of the ISO 639-1 format.

Example:

"en"

is_sync_enabled

boolean

Whether the user can use Box Sync.

Example:

true

job_title

string

The user’s job title.

Maximum string length: 100

Example:

"CEO"

phone

string

The user’s phone number.

Maximum string length: 100

Example:

"6509241374"

address

string

The user’s address.

Maximum string length: 255

Example:

"900 Jefferson Ave, Redwood City, CA 94063"

tracking_codes

Tracking code · object[]

Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.

Show child attributes

can_see_managed_users

boolean

Whether the user can see other enterprise users in their contact list.

Example:

true

timezone

string<timezone>

The user's timezone.

Example:

"Africa/Bujumbura"

is_external_collab_restricted

boolean

Whether the user is allowed to collaborate with users outside their enterprise.

Example:

true

is_exempt_from_device_limits

boolean

Whether to exempt the user from enterprise device limits.

Example:

true

Whether the user must use two-factor authentication.

Example:

true

is_password_reset_required

boolean

Whether the user is required to reset their password.

Example:

true

status

enum<string>

The user's account status.

Available options:

active,

inactive,

cannot_delete_edit,

cannot_delete_edit_upload

Example:

"active"

space_amount

integer<int64>

The user’s total available space in bytes. Set this to -1 to indicate unlimited storage.

Example:

11345156112

notification_email

object

An alternate notification email address to which email notifications are sent. When it's confirmed, this will be the email address to which notifications are sent instead of to the primary email address.

Set this value to null to remove the notification email.

Show child attributes

external_app_user_id

string

An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users.

Note: In order to update this field, you need to request a token using the application that created the app user.

Example:

"my-user-1234"

Response

Returns the updated user object.

A full representation of a user, as can be returned from any user API endpoint.

string

required

The unique identifier for this user.

Example:

"11446498"

type

enum<string>

required

The value will always be user.

Available options:

user

Example:

"user"

name

string

The display name of this user.

Maximum string length: 50

Example:

"Aaron Levie"

The primary email address of this user.

Example:

"[email protected]"

created_at

string<date-time>

When the user object was created.

Example:

"2012-12-12T10:53:43-08:00"

modified_at

string<date-time>

When the user object was last modified.

Example:

"2012-12-12T10:53:43-08:00"

language

string

The language of the user, formatted in modified version of the ISO 639-1 format.

Example:

"en"

timezone

string<timezone>

The user's timezone.

Example:

"Africa/Bujumbura"

space_amount

integer<int64>

The user’s total available space amount in bytes.

Example:

11345156112

space_used

integer<int64>

The amount of space in use by the user.

Example:

1237009912

max_upload_size

integer<int64>

The maximum individual file size in bytes the user can have.

Example:

2147483648

status

enum<string>

The user's account status.

Available options:

active,

inactive,

cannot_delete_edit,

cannot_delete_edit_upload

Example:

"active"

job_title

string

The user’s job title.

Maximum string length: 100

Example:

"CEO"

phone

string

The user’s phone number.

Maximum string length: 100

Example:

"6509241374"

address

string

The user’s address.

Maximum string length: 255

Example:

"900 Jefferson Ave, Redwood City, CA 94063"

avatar_url

string

URL of the user’s avatar image.

Example:

"https://www.box.com/api/avatar/large/181216415"

notification_email

object

Show child attributes

role

enum<string>

The user’s enterprise role.

Available options:

admin,

coadmin,

user

Example:

"admin"

tracking_codes

Tracking code · object[]

Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.

Show child attributes

can_see_managed_users

boolean

Whether the user can see other enterprise users in their contact list.

Example:

true

is_sync_enabled

boolean

Whether the user can use Box Sync.

Example:

true

is_external_collab_restricted

boolean

Whether the user is allowed to collaborate with users outside their enterprise.

Example:

true

is_exempt_from_device_limits

boolean

Whether to exempt the user from Enterprise device limits.

Example:

true

Whether the user must use two-factor authentication.

Example:

true

enterprise

Enterprise · object

Representation of the user’s enterprise.

Show child attributes

my_tags

string[]

Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.

Example:

["important"]

hostname

string

The root (protocol, subdomain, domain) of any links that need to be generated for the user.

Example:

"https://example.app.box.com/"

is_platform_access_only

boolean

Whether the user is an App User.

Example:

true

external_app_user_id

string

An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users.

Example:

"my-user-1234"