Create New User - POST /Users



Create a new user.

The ‘Manage Users’ permission is required to execute this API.

Usage:

  1. GET /Users and get details of all users
  2. POST /Users and create a new user

URL

/cxrestapi/auth/Users

Method:

POST

Media Type (header):

Authorization: Bearer <access token value>
Content-Type: application/json;v=1.0

Parameters

createUserModel=[body]: Specifies the user details
username=[string] - User name
password=[string] - User password
roleIds=[integer] - User related role(s) Id(s)
teamIds=[integer] - User related team(s) Id(s)
authenticationProviderId=[integer] - User authentication provider Id
firstName=[string] -User first name
lastName=[string] - User last name
email=[string] - User email address
phoneNumber=[string] - User phone number
cellPhoneNumber=[string] - User cellular phone number
jobTitle=[string] - User job title
other=[string] - User other information
country=[boolean] - User country
active=[string] - User active/inactive state (true/false)
expirationDate=[string] - User expiration date (date-time)
allowedIpList=[string] - User allowed IPs
localeId=[integer] - User Locale (Id)

Success Response:

Code: 201 Success

Error Response:

Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

no content

Notes:

Returns the location of the created user in the response header. If the request fails, it returns an error response.




Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to usWe appreciate your feedback!