From Bright Pattern Documentation
Jump to: navigation, search
 
Line 2: Line 2:
 
This API is used to create a new user in the system.
 
This API is used to create a new user in the system.
  
 +
== Request ==
 +
=== URL ===
 +
http[s]://<host>/configapi/v2/user
  
== URL ==
+
=== HTTP Method ===
http[s]://<host>:<port>/configapi/v2/user
 
 
 
== Method ==
 
 
POST
 
POST
  
== Request Payload ==
+
== Response ==
{  
+
  {  
"loginId": "test008",
+
  "loginId": "test008",
"password": "top secret",
+
  "password": "top secret",
"firstName": "test",
+
  "firstName": "test",
"lastName": "008",
+
  "lastName": "008",
"team": "Maintenance Renewal",
+
  "team": "Maintenance Renewal",
                   
+
                   
"extension": "2072",
+
  "extension": "2072",
"workPhone": "123456",
+
  "workPhone": "123456",
"mobilePhone": "78910",
+
  "mobilePhone": "78910",
"email": "test008@nowhere.net",
+
  "email": "test008@nowhere.net",
"disabled": false,
+
  "disabled": false,
"changePassword": true,
+
  "changePassword": true,
"skills": {
+
  "skills": {
 
   "Maintenance Renewal": 100,
 
   "Maintenance Renewal": 100,
 
   "English": 33
 
   "English": 33
},
+
  },
"roles": [
+
  "roles": [
 
   "Agent",
 
   "Agent",
 
   "Supervisor"
 
   "Supervisor"
]
+
  ]
}
+
  }
  
  
  
  
<center>[[user-management-api-specification/GetUserData|< Previous]]  |  [[user-management-api-specification/UpdateUser|Next >]]</center>
 
 
</translate>
 
</translate>

Revision as of 23:40, 13 November 2018

• 5.2

<translate>= Create User= This API is used to create a new user in the system.

Request

URL

http[s]://<host>/configapi/v2/user

HTTP Method

POST

Response

 { 
 "loginId": "test008",
 "password": "top secret",
 "firstName": "test",
 "lastName": "008",
 "team": "Maintenance Renewal",
                    
 "extension": "2072",
 "workPhone": "123456",
 "mobilePhone": "78910",
 "email": "test008@nowhere.net",
 "disabled": false,
 "changePassword": true,
 "skills": {
  "Maintenance Renewal": 100,
  "English": 33
 },
 "roles": [
  "Agent",
  "Supervisor"
 ]
 }



</translate>

< Previous | Next >