Groups API

Create group

Creates a membership group with the given name and optional protected pages, and returns the created group.

post/api/sites/multiscreen/{site_name}/membership/groups

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/membership/groups
  • Auth
    HTTP basic

Path parameters

site_namestring required

The site's unique name (its ID), returned when the site is created.

Request body

namestring required

Group name, as displayed in UI

pagesstring[]

List of page uuids to be protected by this group When pages is assigned to a group, it means that site member requires authority/permission 'ACCESS_PAGE_{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.

Example request

{
  "name": "Premium site members",
  "pages": [
    "7b31a091a92049bba02315a3c718ecb1",
    "1a5bfd0df22641db96902fc3c8dfd4f8"
  ]
}

Response

OK

idstring
namestring required

Group name, as displayed in UI

pagesstring[]

List of page uuids to be protected by this group When pages is assigned to a group, it means that site member requires authority/permission 'ACCESS_PAGE_{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.

Example response

{
  "id": "90f33a1b-27bb-4020-9f7d-99d6026547f0",
  "name": "Premium site members",
  "pages": [
    "7b31a091a92049bba02315a3c718ecb1",
    "1a5bfd0df22641db96902fc3c8dfd4f8"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.