Get user
Get a user by its user ID.
| Method | GET
|
| URL | /v1/user/{siteId}/{userId}
|
The received data depends on the access rights of the requester. For details, in User model, see the "Access" column.
Request parameters
|
Parameter |
Type |
Description |
Required |
Default |
|---|---|---|---|---|
|
|
string |
Comma-separated list of column names to return in the response. |
no |
|
|
|
Boolean |
Include the user's agent-group chat settings in the response. |
no |
|
|
|
Boolean |
Include the user's agent-coach status in the response. |
no |
|
|
|
Boolean |
Include the user's agent settings in the response. |
no |
|
|
|
Boolean |
Include the user's user filter in the responses. |
no |
|
|
|
integer |
Site ID. Unique identifier assigned during client-account creation in Nuance Portal. |
yes |
|
|
|
Boolean |
Include the user's skills in the response. |
no |
|
|
|
integer |
User ID. |
yes |
|
Response codes
|
Status |
Description |
|---|---|
|
200 |
Request succeeded. The response has content, which is described in User model. |
|
404 |
The server cannot find the requested user. This user may not exist. |
For a full list of supported response codes for UMAPI, see Response codes.
Samples
Note: Authentication is required to try out samples. For details, see API token authentication.
Sample request
url /portal/configuration/api/v1/user/123/12345678
Sample response (status code 200)
{"id": 12345678,
"username": "JonDoe",
"firstname": "Jon",
"lastname": "Doe",
"allAccess": false,
"lastLogin": 1685648891000,
"failedAttempts": 0,
"locked": false,
"language": "EN",
"expiredDate":1693378800000,
"defaultSiteId": 123,
"numPswdHistory": 5,
"pswdDate": 1685648883000,
"ssoUser": false,
"allAgentGroup": false,
"allBusinessUnit": false,
"dateCreated": 1685674009000,
"roleIds": [
17,
19
],
"roles": [
{"id": 17,
"name": "ROLE_SAAS_CLIENT_ADMINISTRATOR",
"additive": 0,
"applications": [
1
],
"readOnly": false
},
{"id": 19,
"name":"ROLE_SAAS_CLIENT_AGENT",
"additive": 0,
"applications": [
1
],
"readOnly": false
}
],
"siteIds": [
123
],
"sites": [
{"id": 123,
"name": "SiteName",
"agentGroupsActive": true,
"enableAgentCoach": false,
"applications": [
1
]
}
],
"businessUnitIds": [
87654321
],
"businessUnits": [
{"id": 87654321,
"siteId": 123,
"name": "BusinessUnit1"
}
],
"agentCoachStatus": [],
"agentGroupIds": [
10004321
],
"agentGroups": [
{"id": 10004321,
"siteId": 123,
"name": "AgentGroup1",
"enableAgentCoach": false,
"userEnableAgentCoach": false
}
],
"skillIds": [
1234
],
"skills": [
{"id": 1234,
"siteId": 123,
"name": "AgentLocation",
"value": "USA",
"nonReportable": false,
"required": false,
"exclusive": false
}
],
"disabled": false,
"tempLocked": false,
"activated": true,
"programRulesAccess": false,
"syncAdmin": false,
"version": 2
}
Sample error response (status code 404)
{"error": "HTTP 404 Not Found",
"code": 404
}
