PIpiwik
Access Control

User groups permissions for a given app

Lists all user groups and their permissions for a given app.

get/api/access-control/v2/app/{app_id}/permission/user-group

Request

Path parameters

app_idstring uuid required

UUIDv4 identifier of an object

Query parameters

limitinteger

Limits the number of returned items

offsetinteger

Sets offset for list of items

searchstring

Search phrase - search for user group name and user group id

sort'name' | '-name'

Sort field - can be reversed by adding dash before field name e.g (-name)

Response

OK

Example response

{
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "985ed9d7-b652-47b8-b9cf-c17d62735261",
      "attributes": {
        "name": "User Group Name",
        "permission": "manage"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.