Manage Applications

    Create user

    post
    https://api.box.com/2.0
    /users

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

    Request

    application/json

    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

    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

    Specifies that the user is an app user.

    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

    Required, unless is_platform_access_only is set to true.

    stringin bodyrequired
    Aaron Levie50

    The name of the user

    stringin bodyoptional
    6509241374100

    The user’s phone number

    stringin bodyoptional
    user

    The user’s enterprise role

    Value is one of "coadmin", "user"

    integerin bodyoptional
    11345156112

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

    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 a user object for the newly created user.

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

    Request Example

    cURL
    curl -X POST https://api.box.com/2.0/users \
         -H "Authorization: Bearer <ACCESS_TOKEN>" \
         -H "Content-Type: application/json" \
         -d '{
           "login": "ceo@example.com",
           "name": "Aaron Levie"
         }'
    .NET
    var userParams = new BoxUserRequest()
    {
        Name = "Example User",
        Login = "user@example.com"
    };
    BoxUser newUser = await client.UsersManager.CreateEnterpriseUserAsync(userParams);
    Java
    BoxUser.Info createdUserInfo = BoxUser.createEnterpriseUser(api, "user@example.com", "A User");
    Python
    new_user = client.create_user('Dummy User', 'user@example.com')
    Node
    client.enterprise.addUser(
    	'eddard@winterfell.example.com',
    	'Ned Stark',
    	{
    		role: client.enterprise.userRoles.COADMIN,
    		address: '555 Box Lane',
    		status: client.enterprise.userStatuses.CANNOT_DELETE_OR_EDIT
    	})
    	.then(user => {
    		/* user -> {
    			type: 'user',
    			id: '44444',
    			name: 'Ned Stark',
    			login: 'eddard@winterfell.example.com',
    			created_at: '2012-11-15T16:34:28-08:00',
    			modified_at: '2012-11-15T16:34:29-08:00',
    			role: 'coadmin',
    			language: 'en',
    			timezone: 'America/Los_Angeles',
    			space_amount: 5368709120,
    			space_used: 0,
    			max_upload_size: 2147483648,
    			status: 'active',
    			job_title: '',
    			phone: '',
    			address: '555 Box Lane',
    			avatar_url: 'https://www.box.com/api/avatar/large/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"
    }