Skip to main content
Browse Documentation
HTTP - Management

Group

Created by j.moore, last modified by c.neale on 06 Oct 2020

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

Properties

NameData typeDescription
idstringThe group identifier as a 128 bit GUID.
namestringThe unique group name
description stringA description for the purpose of the group.
typestringThe type of group - 'sys', 'contensis', 'external'.
custom.*objectCustom string properties for the group.

Example

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