The GET /users/{userId}/permissions/groups endpoint gets a list of all groups permissions for the user matching the user ID provided.
In this page
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 |
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 group permissions for the user
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/permissions/groups" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>"
Responses
Responses contain a list of all group permissions for the user matching the user ID provided.
Successful response
Successful requests return a 200 Success code and a collection of group permissions.
Example response
{
"meta": {
"page": 1,
"count": 3,
"pageCount": 1,
"totalCount": 3
},
"userId": "2f201ffa-62ff-407c-a3b4-bbc7933beb33",
"groupPermissions": [
{
"groupId": "687c104e-f28a-4985-9467-8f96a5868117",
"groupDisplayId": "9876",
"groupName": "Group1",
"groupPermission": "Read"
},
{
"groupId": "3615beae-3974-4c33-b38d-9ec230b2284c",
"groupDisplayId": "5678",
"groupName": "Group2",
"groupPermission": "Read"
},
{
"groupId": "38c791f5-961e-4578-979f-5f375a9e49ec",
"groupDisplayId": "1234",
"groupName": "Group3",
"groupPermission": "Write"
}
]
}
where:
userId. The unique ID of the user.agentDisplayId. The agent's unique ID.groupPermissions. The user’s group permissions.groupId. The unique ID of the group that the user has access to.groupDisplayID. The unique ID of the group that the user has access to.groupName. The name of the group that the user has access to.groupPermission. Access levels for accessing resources such as groups. Possible values: None, Read, Write.