Skip to main content
POST
/
management
/
v2.0
/
users
Creates a new user.
curl --request POST \
  --url https://api-trial.cognigy.ai/new/management/v2.0/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "password": "<string>",
  "organisation": "<string>",
  "cxoneEmail": "<string>",
  "cxoneId": "<string>",
  "roles": [
    "admin"
  ],
  "acceptedTOS": true,
  "disabled": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "password": "<string>",
  "organisation": "<string>",
  "cxoneEmail": "<string>",
  "cxoneId": "<string>",
  "roles": [
    "admin"
  ],
  "acceptedTOS": true,
  "disabled": true,
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

ā€‹
Authorization
string
header
required

Basic Authentication used by routes designed for the Management-UI.

Headers

ā€‹
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Body

application/json
ā€‹
id
string
required
ā€‹
name
string
required
ā€‹
password
string
required
ā€‹
organisation
string
required
Required string length: 24
ā€‹
cxoneEmail
string

The email address of the CXOne user, only required for NiCE CXOne users

ā€‹
cxoneId
string

The CXOne ID of the user, only required for NiCE CXOne users

ā€‹
roles
enum<string>[]
Available options:
admin,
apiKeys,
base_role,
basicSupportUser,
fullSupportUser,
liveAgentAdmin,
liveAgentAgent,
liveAgentSupervisor,
odata,
projectAssigner,
projectManager,
userManager,
userDetailsViewer,
voiceGatewayUser,
opsCenterUser
ā€‹
acceptedTOS
boolean
ā€‹
disabled
boolean

Response

Returns the created user.

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

ā€‹
id
string
required
ā€‹
name
string
required
ā€‹
password
string
required
ā€‹
organisation
string
required
Required string length: 24
ā€‹
cxoneEmail
string

The email address of the CXOne user, only required for NiCE CXOne users

ā€‹
cxoneId
string

The CXOne ID of the user, only required for NiCE CXOne users

ā€‹
roles
enum<string>[]
Available options:
admin,
apiKeys,
base_role,
basicSupportUser,
fullSupportUser,
liveAgentAdmin,
liveAgentAgent,
liveAgentSupervisor,
odata,
projectAssigner,
projectManager,
userManager,
userDetailsViewer,
voiceGatewayUser,
opsCenterUser
ā€‹
acceptedTOS
boolean
ā€‹
disabled
boolean
ā€‹
_id
string
Required string length: 24
ā€‹
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

ā€‹
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

ā€‹
createdBy
string
Required string length: 24
ā€‹
lastChangedBy
string
Required string length: 24