permissionGroups

Requires an authenticated session.

Lists the permission groups, each with the grantable permissions of its module, for building a permission picker.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PermissionGroups {
  permissionGroups {
    displayName
    description
    icon
    module
    sortOrder
    resources {
      count
      resource
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PermissionGroups {\n  permissionGroups {\n    displayName\n    description\n    icon\n    module\n    sortOrder\n    resources {\n      count\n      resource\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "permissionGroups": [
      {
        "displayName": "string",
        "description": "string",
        "icon": "string",
        "module": "string",
        "sortOrder": 0,
        "resources": [
          {
            "count": 0,
            "resource": "string"
          }
        ]
      }
    ]
  }
}

permissionGroups: [PermissionGroup!]!

Type

PermissionGroup object

A group of permissions for one module.