Skip to main content

Properties

NameTypeFormatDescription
idstring-The group identifier as a 128 bit GUID.
namestring-The unique group name
description string-A description for the purpose of the group.
typestring-The type of group - 'sys', 'contensis', 'external'.
userCountintegerintegerThe count of users in the group
childGroupCountintegerintegerThe count of child groups in the group
custom.*object-Custom 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"
    }
}

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request