Skip to main content
Browse Documentation
HTTP - Management

Group

Created by j.moore, last modified by c.neale on 10 Dec 2020

A group resource contains references to users and child groups that form membership of the group.

Properties

NameData typeData formatDescription
idstringThe group identifier as a 128 bit GUID.
description stringA description for the purpose of the group.
typestringThe type of group - 'sys', 'contensis', 'external'.
userCountintegerintegerThe count of users in the group
childGroupCountintegerintegerThe count of child groups in the group
custom.*objectCustom string properties for the group.

Example

JSON
{ "id": "236f1ce9-e5e6-4a93-b178-d52f2f723428", "name": "Paper Street Soap Company", "description": "Employees of the Paper Street Soap Company", "type": "contensis", "userCount": 2, "childGroupCount": 0, "custom" : { "clientId": "PSSC" } }