REST Resource: groups

{
  "name": string,
  "groupKey": {
    object (EntityKey)
  },
  "additionalGroupKeys": [
    {
      object (EntityKey)
    }
  ],
  "parent": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "dynamicGroupMetadata": {
    object (DynamicGroupMetadata)
  },
  "posixGroups": [
    {
      object (PosixGroup)
    }
  ]
}

string

Output only. The resource name of the Group.

Shall be of the form groups/{groupId}.

object (EntityKey)

Required. The EntityKey of the Group.

object (EntityKey)

Output only. Additional group keys associated with the Group.

string

Required. Immutable. The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy.

Must be of the form identitysources/{identity_source} for external identity-mapped groups or customers/{customerId} for Google Groups. The customerId must begin with "C" (for example, 'C046psxkn'). Find your customer ID.

string

The display name of the Group.

string

An extended description to help users determine the purpose of a Group.

Must not be longer than 4,096 characters.

string (Timestamp format)

Output only. The time when the Group was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Output only. The time when the Group was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

map (key: string, value: string)

Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value.

Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value.

Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added.

Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic.

Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

object (DynamicGroupMetadata)

Optional. Dynamic group metadata like queries and status.

object (PosixGroup)

Optional. The POSIX groups associated with the Group.

{
  "queries": [
    {
      object (DynamicGroupQuery)
    }
  ],
  "status": {
    object (DynamicGroupStatus)
  }
}

object (DynamicGroupQuery)

Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 500 dynamic groups.

object (DynamicGroupStatus)

Output only. Status of the dynamic group.

{
  "resourceType": enum (ResourceType),
  "query": string
}

enum (ResourceType)

string

Query that determines the memberships of the dynamic group.

Examples: All users with at least one organizations.department of engineering.

user.organizations.exists(org, org.department=='engineering')

All users with at least one location that has area of foo and building_id of bar.

user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')

All users with any variation of the name John Doe (case-insensitive queries add equalsIgnoreCase() to the value being queried).

user.name.value.equalsIgnoreCase('jOhn DoE')

{
  "status": enum (Status),
  "statusTime": string
}

enum (Status)

Status of the dynamic group.

string (Timestamp format)

The latest time at which the dynamic group is guaranteed to be in the given status. If status is UP_TO_DATE, the latest time at which the dynamic group was confirmed to be up-to-date. If status is UPDATING_MEMBERSHIPS, the time at which dynamic group was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

{
  "name": string,
  "gid": string,
  "systemId": string
}

string

Name of the POSIX group.

string

GID of the POSIX group.

string

System identifier for which group name and gid apply to. If not specified it will default to empty value.