Return a list of permissions for a user group

Description

Returns properties for a user group with the provided ID, or a 404 if no such user group is found.

GET /v1/security/user_groups/{userGroupId}/permissions

Parameters

Parameter	In	Type	Required	Description
userGroupId	path	string	true	The ID of the User Group.
pageSize	query	integer	false	Limit number of results returned (Max 100).
page	query	integer	false	Page number to retrieve in the paginated results (0-based index).

Code Samples

curl

curl -X GET https://h.app.wdesk.com/s/wdata/oc/api/v1/security/user_groups/{userGroupId}/permissions \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}'

httpie

http GET https://h.app.wdesk.com/s/wdata/oc/api/v1/security/user_groups/{userGroupId}/permissions \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://h.app.wdesk.com/s/wdata/oc/api/v1/security/user_groups/{userGroupId}/permissions" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}'

python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://h.app.wdesk.com/s/wdata/oc/api/v1/security/user_groups/{userGroupId}/permissions', headers = headers)

print(r.json())

Returns

200 - OK

Returns a PermissionsResponse containing an array of Permission objects for the provided userGroupId.

Example Responses

OK

{
  "data": [
    {
      "id": "1",
      "object_id": "12",
      "object_type": "Chain",
      "object_name": "Regression Test",
      "name": "read",
      "user_groups": [
        {
          "id": "1",
          "name": "Admins",
          "default": true,
          "created_at": "2018-03-14 20:10:39.520585"
        }
      ]
    }
  ]
}