Manage Applications

    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

    application/json

    Path Parameters

    stringin pathrequired
    12345

    The ID of the user.

    Query Parameters

    string arrayin queryoptional
    id,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

    stringin bodyoptional
    900 Jefferson Ave, Redwood City, CA 94063255

    The user’s address

    booleanin bodyoptional
    true

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

    stringin bodyoptional
    null

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

    booleanin bodyoptional
    true

    Whether to exempt the user from enterprise device limits

    booleanin bodyoptional
    true

    Whether the user must use two-factor authentication

    booleanin bodyoptional
    true

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

    booleanin bodyoptional
    true

    Whether the user is required to reset their password

    booleanin bodyoptional
    true

    Whether the user can use Box Sync

    stringin bodyoptional
    CEO100

    The user’s job title

    string / ISO639-1-BOXin bodyoptional
    en

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

    stringin bodyoptional
    boss@box.com

    The email address the user uses to log in

    stringin bodyoptional
    Aaron Levie50

    The name of the user

    booleanin bodyoptional
    true

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

    stringin bodyoptional
    6509241374100

    The user’s phone number

    stringin bodyoptional
    user

    The user’s enterprise role

    Value is one of "coadmin", "user"

    stringin bodyoptional
    active

    The user's account status

    Value is one of "active", "inactive", "cannot_delete_edit", "cannot_delete_edit_upload"

    string / timezonein bodyoptional
    Africa/Bujumbura

    The user's timezone

    string arrayin bodyoptional
    ["code1: 12345"]

    An array of key/value pairs set by the user’s admin

    Response

    application/jsonUser

    Returns the updated user object.

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

    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' }
            */
        });

    Response Example

    {
      "id": 11446498,
      "type": "user",
      "name": "Aaron Levie",
      "login": "ceo@example.com",
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "language": "en",
      "timezone": "Africa/Bujumbura",
      "space_amount": 11345156112,
      "space_used": 1237009912,
      "max_upload_size": 2147483648,
      "status": "active",
      "job_title": "CEO",
      "phone": 6509241374,
      "address": "900 Jefferson Ave, Redwood City, CA 94063",
      "avatar_url": "https://www.box.com/api/avatar/large/181216415",
      "role": "admin",
      "tracking_codes": [
        {
          "type": "tracking_code",
          "name": "department",
          "value": "Sales"
        }
      ],
      "can_see_managed_users": true,
      "is_sync_enabled": true,
      "is_external_collab_restricted": true,
      "is_exempt_from_device_limits": true,
      "is_exempt_from_login_verification": true,
      "enterprise": {
        "id": 11446498,
        "type": "enterprise",
        "name": "Acme Inc."
      },
      "my_tags": [
        "important"
      ],
      "hostname": "https://example.app.box.com/",
      "is_platform_access_only": true,
      "external_app_user_id": "my-app-user"
    }