Group Resource

The Group resource represents a Group, used to assign a Security Policy to a set of users.

The list response and the get/create/update response use different shapes. The list (index) response is a brief view; get/create/update return a full view. Attributes are not a strict superset/subset of each other — see the tables below.

Brief View (returned only by List Groups)

Attribute	Type	Description
id	integer	Group ID.
name	string	Group name.
policy_id	integer	ID of the Security Policy assigned to this Group. Only present in the brief (list) view — the full view represents the policy as a nested `policy` object instead (see below).
total_users	integer	Count of users currently in this Group. Only present in the brief (list) view.

Full View (returned by Get, Create, Update)

Attribute	Type	Description
id	integer	Group ID.
name	string	Group name.
policy	object	The assigned Security Policy, as `{ "id": integer, "name": string }`. Absent (empty object) if no policy is assigned. Not present as a flat `policy_id` in this view.
admins	array of objects	Users with `MANAGE_GROUP` privilege on this Group, each as `{ "id": integer, "email": string, "first_name": string, "last_name": string }`. Read-only — not settable via Create/Update.
users	array of objects	Users who are members of this Group, each as `{ "id": integer, "email": string, "first_name": string, "last_name": string }`. Read-only — not settable via Create/Update. There is no pagination on this embedded array.

Request-Only Attributes (Create/Update)

These attributes can be sent in Create Group and Update Group requests.

Attribute	Type	Description
name	string	Required. Must be unique within the account.
policy_id	integer	Optional. ID of a Security Policy on the same account to assign to this Group. Must reference an existing Policy or the request fails validation.
reference	string	Optional. An external reference/identifier for the Group. Must be unique within the account (blank allowed). Write-only — this value is never returned in any API response (it does not appear in either the brief or full presenter structure).