Groups Commands

• getSystemGroups

getSystemGroups

---

Lists all user groups in the tenant with their metadata, including group UUIDs, names, roles, and tenant identifiers. Use this command to look up a group's UUID before assigning it to a case team with setCase.

Arguments

Arguments

Argument Name	Description	Required
include_account_groups	Whether to include account-level groups (shared across tenants) in the results. Possible values are: true, false. Default is true.	Optional

Outputs

Outputs

Core.SystemGroup.groupId string

Unique group identifier (UUID with tenant suffix).

Core.SystemGroup.groupName string

Display name of the group.

Core.SystemGroup.roleName string

Role assigned to this group. May be empty when no role is set.

Core.SystemGroup.groupType string

Group type. 'Custom' for tenant-defined groups, 'AD' for Active Directory groups.

Core.SystemGroup.xdrId string

Tenant XDR ID. The value '0' indicates an account-level (cross-tenant) group.