Update user

put

https://api.box.com/2.0

/users/:user_id

Updates a managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Request

Content-Typeapplication/json

Path Parameters

user_id stringin pathrequired

example12345

The ID of the user.

Query Parameters

fieldsstring arrayin queryoptional

exampleid,type,name

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.

Request Body

address stringin bodyoptional

example900 Jefferson Ave, Redwood City, CA 94063Max Length255

The user’s address

can_see_managed_users booleanin bodyoptional

exampletrue

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

enterprise stringin bodyoptional

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

is_exempt_from_device_limits booleanin bodyoptional

exampletrue

Whether to exempt the user from enterprise device limits

is_exempt_from_login_verification booleanin bodyoptional

exampletrue

Whether the user must use two-factor authentication

is_external_collab_restricted booleanin bodyoptional

exampletrue

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

is_password_reset_required booleanin bodyoptional

exampletrue

Whether the user is required to reset their password

is_sync_enabled booleanin bodyoptional

exampletrue

Whether the user can use Box Sync

job_title stringin bodyoptional

exampleCEOMax Length100

The user’s job title

language stringin bodyoptional

exampleen

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

name stringin bodyoptional

exampleAaron LevieMax Length50

The name of the user

notification_email objectin body

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.

notification_email.email stringnulloptional

examplenotifications@example.com

The email address to send the notifications to.

notify booleanin bodyoptional

exampletrue

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

phone stringin bodyoptional

example6509241374Max Length100

The user’s phone number

role stringin bodyoptional

exampleuser

The user’s enterprise role

Value is one of coadmin,user

space_amount integerin bodyoptional

example11345156112

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

status stringin bodyoptional

exampleactive

The user's account status

Value is one of active,inactive,cannot_delete_edit,cannot_delete_edit_upload

timezone string / timezonein bodyoptional

exampleAfrica/Bujumbura

The user's timezone

tracking_codesstring arrayin bodyoptional

example["code1: 12345"]

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.

Response

200application/jsonUser

Returns the updated user object.

400application/jsonClient error

Returns an error if some of the parameters are missing or not valid.

invalid_parameter when a parameter is formatted incorrectly, for example when the notification_email has an incorrectly formatted email address.

403application/jsonClient error

Returns an error if the user is not allowed to make the changes.

access_denied_insufficient_permissions when the user does not have the right permissions, for example when updating the notification email is turned off for the enterprise.

defaultapplication/jsonClient error

An unexpected client error.

put

Update user

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -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)")
}