User Group

The User Group object represents a group containing users.

This object contains the following attributes:

Field	Type	Description
id	string, core	(Read-only) Primary identifier for the group.
icon	string	(Optional) The relative path to the group's icon image or logo.
name	string, core	The name of the group.
description	string	(Optional) A description of the group.
modules	object	(Optional) Represents the modules object, which contains modules that the group members can access.
default	bool	Indicates if the group has been set as a default group within the account. An account can contain only one default group.
users	object	(Read-only)Represents the user object containing users assigned to the group. A group can be deleted only if no user is assigned.

Example

USER GROUP OBJECT

{
	"id": "UGR-5116-6265",
	"name": "Jane Doe",
	"description": "This group contains all Accounts team members",
	"modules": [
		{
			"id": "MOD-1756-1452",
			"name": "Access management"
		},
		{
			"id": "MOD-9042-8216",
			"name": "Account management"
		}
	],
	"icon": "https://picsum.photos/210/201",
	"default": true,
    "users": [
        {
            "id": "USR-0000-0016",          
            "icon": null,
            "name": "Reto Mayer"
        }
    ]
}