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. The resource name of the Group.

Shall be of the form groups/{group}.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The names of fields to update.

May only contain the following field names: display_name, description, labels.

This is 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.

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 Authorization guide.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-16 UTC.