# Update Users

**PUT /users**

This API call is used to update all fields of existing users.

**Note:**
- The following fields are not updatable: `userName`, `password`, `userAccess.AccessAutomation`, `userAccess.AccessCertification`, `userAccess.AccessComplete`, `userAccess.AccessOperationalMatching`.
- A limit of 1000 user records are allowed per request to allow processing within request timeout value. 


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


## Authentication methods
- Bearer auth


## Parameters



### Body: application/json (object)

- **userName** (string)
  The username of the user.
- **name** (object)

- **email** (string)
  The email address must be unique within the system and adhere to the email format requirements.
- **phoneNumber** (string)
  The phone number of the user.
- **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)
  Indicates whether the user is locked out from 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)