REST API

Group

Updated: December 19, 2019

This page is scheduled for review and update. Check back soon for updated content!

Representation of a Group.

Resource Representation

{
  "entity-type": "group",
  "id": string,
  "properties": object,
  "memberUsers": [
    string
  ],
  "memberGroups": [
    string
  ],
  "parentGroups": [
    string
  ],
  "contextParameters": object
}
Property Name Value Description Notes
entity-type string The entity type name. Value: the fixed string "group".
id string The group id.
properties object A collection of key-value pairs of group properties.
memberUsers[] list The list of group member user ids, if the fetch property memberUsers is set. Optional
memberGroups[] list The list of group member group ids, if the fetch property memberGroups is set. Optional
parentGroups[] list The list of group parent group ids, if the fetch property parentGroups is set. Optional
contextParameters object A collection of key-value pairs filled by enabled enrichers. Optional

We'd love to hear your thoughts!

All fields required