From Bright Pattern Documentation
Jump to: navigation, search
Line 37: Line 37:
 
<syntaxhighlight  lang="json">
 
<syntaxhighlight  lang="json">
 
  {
 
  {
−
  "loginId" : "sheila.thomas",
+
  "disabled":false,
−
  "firstName" : "Sheila",
+
  "changePassword":false,
−
  "lastName" : "Thomas",
+
  "skills":{},
−
  "team" : "Customer Service",
+
  "loginId":"homer.simpson",
−
"email": "sheila.thomas@yourcompany.com",
+
  "firstName":"Homer",
−
  "extension": "2072",
+
  "lastName":"Simpson",
−
  "workPhone": "123456",
+
  "team":"Customer Service",
−
  "mobilePhone": "78910",
+
  "extension":"1048",
−
  "disabled": false,
+
  "email":"homer.simpson@gmail.com",
−
"changePassword": true,
+
  "roles":["Agent"]
−
  "skills": {
 
−
  "Customer Service": 100,
 
−
  "English": 33
 
−
},
 
−
  "roles": ["Agent"]
 
 
  }
 
  }
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
=== Response Parameters ===
 +
{|border="1" style="border-collapse:collapse" cellpadding="5"
 +
| '''Parameter'''
 +
| '''Data-Type'''
 +
| '''Description'''
 +
| '''Example'''
 +
|-
 +
| disabled
 +
| Boolean
 +
| Whether the user is disabled ("true") or not ("false")
 +
| false
 +
|-
 +
| changePassword
 +
| Boolean
 +
| Whether the user must change password  ("true") on next login or not ("false")
 +
| false
 +
|-
 +
| skills
 +
| array
 +
| The user's auxiliary skills
 +
| {["English"], ["Spanish"]}
 +
|-
 +
| loginId
 +
| string
 +
| The username of the user
 +
| "frank.zappa"
 +
|-
 +
| firstName
 +
| string
 +
| The first name of the user
 +
| "Frank"
 +
|-
 +
| lastName
 +
| string
 +
| The last name of the user
 +
| "Zappa"
 +
|-
 +
| team
 +
| string
 +
| The name of the team assigned to the user
 +
| "Customer Service"
 +
|-
 +
| extension
 +
| number
 +
| The phone extension number of the user
 +
| "1048"
 +
|-
 +
| email
 +
| string
 +
| The email address of the user
 +
| "frank.zappa@gmail.com"
 +
|-
 +
| roles
 +
| array
 +
| The role assigned to the user
 +
| ["Agent"], ["Supervisor"]
 +
|}
  
  

Revision as of 19:00, 11 March 2019

• 5.2

<translate>= Get User Data= Returns user data, such as name, team, extension, skills, and so forth.

Request

URL

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

HTTP Method

GET

Content-Type

application/json

Parameters

Parameter Data-Type Description Example
loginId string The username of the user that you want to get data for "sheila.thomas"

Request Body

Empty. All you need is the username in the URL and the content-type header.


Response

In response to a successful request, the user data is displayed in JSON. You can verify user data by checking the same user information in Contact Center Administrator > Users & Teams > Users.

For failed requests, no user data is shown.

Example Response

 {
 "disabled":false,
 "changePassword":false,
 "skills":{},
 "loginId":"homer.simpson",
 "firstName":"Homer",
 "lastName":"Simpson",
 "team":"Customer Service",
 "extension":"1048",
 "email":"homer.simpson@gmail.com",
 "roles":["Agent"]
 }

Response Parameters

Parameter Data-Type Description Example
disabled Boolean Whether the user is disabled ("true") or not ("false") false
changePassword Boolean Whether the user must change password ("true") on next login or not ("false") false
skills array The user's auxiliary skills {["English"], ["Spanish"]}
loginId string The username of the user "frank.zappa"
firstName string The first name of the user "Frank"
lastName string The last name of the user "Zappa"
team string The name of the team assigned to the user "Customer Service"
extension number The phone extension number of the user "1048"
email string The email address of the user "frank.zappa@gmail.com"
roles array The role assigned to the user ["Agent"], ["Supervisor"]



</translate>

< Previous | Next >
Retrieved from "https://help.brightpattern.com/index.php?title=5.2:User-management-api-specification/GetUserData&oldid=33964"