From Bright Pattern Documentation
m |
|||
| Line 1: | Line 1: | ||
<translate>= Update User= | <translate>= Update User= | ||
| − | Changes a user's password, system status (i.e., active | + | Changes a user's password, system status (i.e., disabled or active), and skills. |
== Request == | == Request == | ||
| Line 9: | Line 9: | ||
PUT | PUT | ||
| − | == | + | === Content-Type === |
| + | application/json | ||
| + | |||
| + | === Parameters === | ||
| + | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| + | | '''Parameter''' | ||
| + | | '''Data-Type''' | ||
| + | | '''Description''' | ||
| + | | '''Example''' | ||
| + | |- | ||
| + | | password | ||
| + | | string | ||
| + | | The user password | ||
| + | | "ChangeMe" | ||
| + | |- | ||
| + | | disabled | ||
| + | | Boolean | ||
| + | | Whether the user is disabled ("true") or active ("false") in the system | ||
| + | | "false" | ||
| + | |- | ||
| + | | changePassword | ||
| + | | string | ||
| + | | Whether the user must change password ("true") on next login or not ("false") | ||
| + | | "false" | ||
| + | |- | ||
| + | | skills | ||
| + | | array | ||
| + | | The name of the team assigned to the new user | ||
| + | | "Customer Service" | ||
| + | |} | ||
| + | |||
| + | === Example Request Body Content === | ||
| + | <syntaxhighlight lang="json"> | ||
{ | { | ||
"password": "top secret", | "password": "top secret", | ||
| Line 16: | Line 48: | ||
"skills": { | "skills": { | ||
"Maintenance Renewal": 100, | "Maintenance Renewal": 100, | ||
| − | "English": 33 | + | "English": 33} |
| − | |||
} | } | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | |||
| + | == Response == | ||
| + | In response to a successful request, the user's properties are updated with the provided parameters, and [[User-management-api-specification/GetUserData | user data]] is retrieved. | ||
| + | |||
| + | Verify the updates in either the response data or in ''Contact Center Administrator > Users & Teams > [[5.3:Contact-center-administrator-guide/Users | Users]]''. | ||
| + | === Example Response === | ||
| + | <syntaxhighlight lang="json"> | ||
| + | { | ||
| + | "disabled":false, | ||
| + | "changePassword":false, | ||
| + | "skills":{}, | ||
| + | "loginId":"lisa.simpson", | ||
| + | "firstName":"lisa", | ||
| + | "lastName":"simpson", | ||
| + | "team":"Customer Service", | ||
| + | "extension":"1027", | ||
| + | "email":"lisa.simpson@brightpattern.com", | ||
| + | "roles":["Agent"] | ||
| + | } | ||
| + | </syntaxhighlight> | ||
Revision as of 18:13, 12 March 2019
• 5.2
<translate>= Update User= Changes a user's password, system status (i.e., disabled or active), and skills.
Request
URL
http[s]://<host>/configapi/v2/user/<login_id>
HTTP Method
PUT
Content-Type
application/json
Parameters
| Parameter | Data-Type | Description | Example |
| password | string | The user password | "ChangeMe" |
| disabled | Boolean | Whether the user is disabled ("true") or active ("false") in the system | "false" |
| changePassword | string | Whether the user must change password ("true") on next login or not ("false") | "false" |
| skills | array | The name of the team assigned to the new user | "Customer Service" |
Example Request Body Content
{
"password": "top secret",
"disabled": false,
"changePassword": true,
"skills": {
"Maintenance Renewal": 100,
"English": 33}
}
Response
In response to a successful request, the user's properties are updated with the provided parameters, and user data is retrieved.
Verify the updates in either the response data or in Contact Center Administrator > Users & Teams > Users.
Example Response
{
"disabled":false,
"changePassword":false,
"skills":{},
"loginId":"lisa.simpson",
"firstName":"lisa",
"lastName":"simpson",
"team":"Customer Service",
"extension":"1027",
"email":"lisa.simpson@brightpattern.com",
"roles":["Agent"]
}
</translate>