REST Resource: customers.v2.Groups

Resource: Group

SCIM representation of a group.

JSON representation 
{
  "schemas": [
    string
  ],
  "members": [
    {
      object (Member)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "displayName": string,
  "urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup": {
    object (CloudIdentityGroupExtension)
  }
}
Fields
schemas[]

string

Required. A list of URIs which indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure. Must only contain values defined as schema and schemaExtensions for the Group ResourceType.
members[]

object (Member)

Optional. The list of members in this group. This attribute is not currently returned. Group memberships can be modified through PATCH requests.
id

string

Identifier. The unique ID for the group. The attribute characteristics are caseExact as true, a mutability of readOnly, and a returned characteristic of always.
externalId

string

Optional. An identifier for the resource as defined by the provisioning client.
meta

object (Meta)

Output only. Resource metadata. All sub-attributes have a mutability of readOnly and a returned characteristic of default.
displayName

string

Required. The group's display name.
urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup

object (CloudIdentityGroupExtension)

Required. Cloud Identity specific group attributes.

Member

SCIM representation of a group member.

JSON representation 
{
  "value": string,
  "$ref": string
}
Fields
value

string

Immutable. Identifier of the member of this Group.
$ref

string

Immutable. The URI for the member.

CloudIdentityGroupExtension

Defines the attributes for the Google Cloud Identity Group extension. The schema URN for this extension is: urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup.

JSON representation 
{
  "email": string,
  "description": string
}
Fields
email

string

Required. The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The email must be unique. Group email addresses are subject to the same character usage rules as usernames. For details, see the help center documentation.
description

string

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

Limit: 4,096 characters.

Methods

create

 Creates a Group.

delete

 Deletes a Group.

get

 Retrieves a Group.

list

 Retrieves a list of Groups.

patch

 Updates a Group using SCIM patch semantics.