Group object representation

The group object representation and fields are described below.

group was introduced in API version V1

group has not been marked for deprecation

Usages

Group

Description

A group of identities (people) which can be used for various purposes like permissions or collections of identities like a mailing list or a community

Example create representation

{
  "name" : "Employees",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  }
}

Example response representation

{
  "urn" : "822ff206-f4f8-412e-a648-2b4fab3fea10",
  "url" : "/n/v1/group/822ff206-f4f8-412e-a648-2b4fab3fea10",
  "name" : "Employees",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  }
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	The URN of the membership group
url	URL represented as a string	The URL of the membership group
name	String literal	The name of the membership group	Maximum length: 255.
owner	company	The company which owns the group	Required on create.
entity	entity	Content entities associated with the group	Ignored on update.