With the https://{tenant_url}/configapi/v2/user endpoint you can:
- Create new users and define most of their attributes
- Update existing users
- Check and clear user lockout state
- Manage agents' skills
- Delete existing users
Below is a brief description of all user attributes that can be accessed via this.
- All attributes are strings unless otherwise noted.
- All attributes are optional unless otherwise noted.
| Attribute | Description |
|---|---|
| loginId | Username. Required to create user. Used to identify the user in all subsequent User Management API operations. |
| password | Password. Required to create user. Format must comply with security policy. |
| changePassword | Indicates whether user must change password on next login. Boolean. Default is false. |
| firstName | First name. Required to create user. |
| lastName | Last name. Required to create user. |
| team | Team that the user is assigned to. Required to create user. |
| extension | User's extension number. If not specified, an extension will be created and assigned automatically. |
| workPhone | User's work phone number. |
| mobilePhone | User's mobile phone number. |
| User's email address. | |
| disabled | Indication whether the user account is disabled or enabled. Boolean (true/flase). |
| skills | For agents an array of skills with levels (e.g., "Support": 75). |
| roles | An array of user's roles (e.g., Agent). |