Method: groups.patch

Updates a Group.

HTTP request

PATCH https://cloudidentity.googleapis.com/v1/{resource.name=groups/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resource.name

string

Output only. Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.

Must be left blank while creating a Group.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Editable fields: displayName, description

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Group.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-identity.groups
  • https://www.googleapis.com/auth/cloud-identity
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.