Bulk Users Create

The endpoint allows you to create a bulk job to asynchronously create users. See Create a System User for the full list of attributes.

Default User State

The state of each user in the request can be explicitly passed in or omitted. If state is omitted, then the user will get created using the value returned from the Get an Organization endpoint. The default user state for bulk created users depends on the creation-source header. For creation-source:jumpcloud:bulk the default state is stored in settings.newSystemUserStateDefaults.csvImport. For other creation-source header values, the default state is stored in settings.newSystemUserStateDefaults.applicationImport

These default state values can be changed in the admin portal settings or by using the Update an Organization endpoint.

Sample Request

curl -X POST https://console.jumpcloud.com/api/v2/bulk/users \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-d '[
  {
    "email":"{email}",
    "firstname":"{firstname}",
    "lastname":"{firstname}",
    "username":"{username}",
    "attributes":[
      {
        "name":"EmployeeID",
        "value":"0000"
      },
      {
        "name":"Custom",
        "value":"attribute"
      }
    ]
  }
]'