Create user


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



Query Parameters

string arrayin queryoptional

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 94063"255

The user’s address

booleanin bodyoptional

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

stringin bodyoptional

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.

booleanin bodyoptional

Whether to exempt the user from enterprise device limits

booleanin bodyoptional

Whether the user must use two-factor authentication

booleanin bodyoptional

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

booleanin bodyoptional

Specifies that the user is an app user.

booleanin bodyoptional

Whether the user can use Box Sync

stringin bodyoptional

The user’s job title

stringin bodyoptional

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

stringin bodyoptional

The email address the user uses to log in

Required, unless is_platform_access_only is set to true.

stringin bodyrequired
"Aaron Levie"50

The name of the user

stringin bodyoptional

The user’s phone number

stringin bodyoptional

The user’s enterprise role

Value is one of coadmin,user

integer (int64)in bodyoptional

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

stringin bodyoptional

The user's account status

Value is one of active,inactive,cannot_delete_edit,cannot_delete_edit_upload

string (timezone)in bodyoptional

The user's timezone

object arrayin bodyoptional

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.

stringin bodyoptional


Value is always tracking_code

stringin bodyoptional

The name of the tracking code, which must be preconfigured in the Admin Console

stringin bodyoptional

The value of the tracking code


application/jsonUser (Full)

Returns a user object for the newly created user.

application/jsonClient error

An unexpected client error.

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

Request Example

curl -i -X POST "" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "login": "",
       "name": "Aaron Levie"
TypeScript Gen
await client.users.createUser({
  name: userName,
  isPlatformAccessOnly: true,
} satisfies CreateUserRequestBody);
Python Gen
client.users.create_user(user_name, is_platform_access_only=True)
.NET Gen (Beta)
await client.Users.CreateUserAsync(requestBody: new CreateUserRequestBody(name: userName) { IsPlatformAccessOnly = true });
new_user = client.create_user('Temp User', '')
var userParams = new BoxUserRequest()
    Name = "Example User",
    Login = ""
BoxUser newUser = await client.UsersManager.CreateEnterpriseUserAsync(userParams);
BoxUser.Info createdUserInfo = BoxUser.createEnterpriseUser(api, "", "A User");
	'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: '',
			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: '' }
client.users.create(login: "", name: "New User") { (result: Result<User, BoxSDKError>) in
    guard case let .success(user) = result else {
        print("Error creating user")

    print("Created user \(, with login \(user.login)")

Response Example

  "id": "11446498",
  "type": "user",
  "address": "900 Jefferson Ave, Redwood City, CA 94063",
  "avatar_url": "",
  "can_see_managed_users": true,
  "created_at": "2012-12-12T10:53:43-08:00",
  "enterprise": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  "external_app_user_id": "my-user-1234",
  "hostname": "",
  "is_exempt_from_device_limits": true,
  "is_exempt_from_login_verification": true,
  "is_external_collab_restricted": true,
  "is_platform_access_only": true,
  "is_sync_enabled": true,
  "job_title": "CEO",
  "language": "en",
  "login": "",
  "max_upload_size": 2147483648,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "my_tags": [
  "name": "Aaron Levie",
  "notification_email": {
    "email": "",
    "is_confirmed": true
  "phone": "6509241374",
  "role": "admin",
  "space_amount": 11345156112,
  "space_used": 1237009912,
  "status": "active",
  "timezone": "Africa/Bujumbura",
  "tracking_codes": [
      "type": "tracking_code",
      "name": "department",
      "value": "Sales"