Membership Groups Object

{
  "cursor": "eyJjdXJzb3IiOiJjdXJzb3IiLCAiY3JlYXRpb25faWQiOiIxNWY0YjNiNGUtNGIzYi00YjNiLTRiM2ItNGIzYi00YjNiNGU0YjNiNGUifQ==",
  "limit": 50,
  "next_page": "eyJjcmVhdGlvbl9pZCI6IjE1ZjRiM2I0ZS00YjNiLTRiM2ItNGIzYi00YjNiLTRiM2I0ZTRiM2I0ZSIsImN1cnNvciI6ImN1cnNvciJ9",
  "results": [
    {
      "id": "90f33a1b-27bb-4020-9f7d-99d6026547f0",
      "name": "Premium site members",
      "pages": [
        "7b31a091a92049bba02315a3c718ecb1",
        "1a5bfd0df22641db96902fc3c8dfd4f8"
      ]
    }
  ],
  "site_name": "string",
  "total_responses": 0
}

Field

Description

cursor string

Cursor-based offset provided in previous page response.

limit
number

Page size (number of elements per page). Default value: 50

next_page
string

Cursor-based offset for next page of data.

results
object

See the section below for details.

site_name
string

The unique identifier of the target site.

total_responses
number

Total number of entities in for given site.

Results Object

Field

Description

id string

The group id.

name
string

The group name, as displayed in UI.

pages
array

List of page uuids to be protected by the group. When pages is assigned to a group, it means that site member requires authority/permission 'ACCESSPAGE{page-uuid}' to access this page. Authority is granted to site member if he belongs to this group or if this authority is granted to him by identity provider.