# Create Users

**POST /users**

This API call is used to create new users.

**Note**: A limit of 1000 user records are allowed per request to allow processing within request timeout value.

### Username and Email Collisions

If you try to create a user with a username or email that is already associated with another user, the operation will fail and return an HTTP status code 400 (Bad Request). 


## Servers
- Sandbox server URL: https://localhost:8080 (Sandbox server URL)


## Authentication methods
- Bearer auth


## Parameters



### Body: application/json (object)

- **userName** (string)
  The username must be unique within the system and adhere to the specified format requirements.
- **password** (string)
  The password must adhere to the password complexity rule.
- **name** (object)

- **email** (string)
  The email address must be unique within the system and adhere to the email format requirements.
- **phoneNumber** (string)

- **roles** (array[object])

- **userAccess** (object)

- **departmentId** (string)
  This value must be a department code configured in Certification.
- **locationId** (string)
  This value must be a location code configured in Certification.
- **programAdminRoleId** (string)
  This value must be a program admin role configured in Certification.
- **lockedOut** (boolean)
  The user locked out status for accessing the system.


## Responses
### 200
Successful Response

#### Body: application/json (object)
- **totalProcessed** (integer)
  Number of users processed from request.
- **successCount** (integer)
  Number of users successfully processed.
- **failureCount** (integer)
  Number of users failed to process.
- **successResults** (array[object])
  Success result details.
- **failedResults** (array[object])
  Failed result details.

### 400
Failed Response

#### Body: application/json (object)
- **totalProcessed** (integer)
  Number of users processed from request.
- **successCount** (integer)
  Number of users successfully processed.
- **failureCount** (integer)
  Number of users failed to process.
- **successResults** (array[object])
  Success result details.
- **failedResults** (array[object])
  Failed result details.

### 401
Authentication Error. Invalid credentials.

#### Body: application/json (object)
- **code** (string)

- **message** (string)

- **description** (string)


### 403
Authorization Error. Invalid role for request.


[Powered by Bump.sh](https://bump.sh)