Create User
This operation is part of the Users API section of the Web Services API.
Overview
Creates a user in the contact center (requires an administrator role).
Request URL | /api/v2/users |
---|---|
HTTP Method | POST |
Required Features | api-provisioning-write |
Body
Includes five mandatory parameters (see Users Resource for details):
- firstName
- lastName
- roles
- userName
- password
Samples
Request
POST /api/v2/users
HTTP Response
The response contains the uri of the user, id of the user, and the path:
{
"statusCode": "0",
"path": "/users/fd6a9f53875a41e2895b2e24e880cc7e",
"id": "fd6a9f53875a41e2895b2e24e880cc7e",
"uri": "http://localhost:8080/api/v2/users/fd6a9f53875a41e2895b2e24e880cc7e"
}
If the userName is already in use, 403 FORBIDDEN is returned.
{
"statusCode": "18",
"statusMessage": "Failed to create user. User 'test' already exists."
}
This page was last edited on October 31, 2023, at 13:32.
Comments or questions about this documentation? Contact us for support!