The GET /users/{userId}/permissions/accessPermissions
endpoint gets a list of all access permissions for the user matching the provided user ID.
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Insert excerpt _ExcerptAPICloudNextGen _ExcerptAPICloudNextGen nopanel true
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
Scope | Access granted |
---|---|
users:read | Entire endpoint |
users:write | Entire endpoint |
self:read | Entire endpoint |
Parameters
The endpoint accepts the following query parameters:
userID
Type | Required | Example |
---|---|---|
String | True | 2f9207ca-8922-4245-bfc5-d8f42939e29a |
The user ID of the required user.
limit
Type | Required | Example |
---|---|---|
integer | False | 25 |
The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.
page
Type | Required | Example |
---|---|---|
integer | False | 1 |
The required page. Minimum of 1, maximum of 1000000000. Default is 1.
Requests
Request a list of queue permissions for the user
Code Block | ||||
---|---|---|---|---|
| ||||
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/permissions/accessPermissions" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>" |
Responses
Responses contain a list of all access permissions for the user matching the user ID provided.
Successful response
Successful requests return a 200 Success
code.
Example response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"meta": {
"page": 1,
"count": 2,
"pageCount": 1,
"totalCount": 2
},
"userId": "895db16f-5270-6ef8-e173-10ea365aefcc",
"accessPermissions": [
{
"permissionKey": "CPA_View",
"permissionLevel": "Yes"
},
{
"permissionKey": "CPA_ACD",
"permissionLevel": "Modify"
}
]
} |
where:
userId
. The unique ID of the user.accessPermissions
. The user’s access permissions.permissionKey
. The user’s access permission key that the user has access to.permissionLevel
. The levelof the access permission that the user has access to.
Insert excerpt _ExcerptRunInPostman _ExcerptRunInPostman nopanel true