Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1339117150.4 KB
groups

Updates a Group.

patch/v1/{+name}

Path parameters

namestring required

Output only. The resource name of the Group. Shall be of the form groups/{group}.

Query parameters

updateMaskstring

Required. The names of fields to update. May only contain the following field names: display_name, description, labels.

updateMaskstring

Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated.

Request body

descriptionstring

An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.

updateTimestring google-datetime

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

parentstring

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/{customer_id} for Google Groups. The customer_id must begin with "C" (for example, 'C046psxkn'). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793)

createTimestring google-datetime

Output only. The time when the Group was created.

namestring

Output only. The resource name of the Group. Shall be of the form groups/{group}.

displayNamestring

The display name of the Group.

labelsobject

Required. One or more label entries that apply to the Group. 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. Google Groups can be locked. To lock a group, add a label with a key of cloudidentity.googleapis.com/groups.locked and an empty value. Doing so locks the group. To unlock the group, remove this label.

Response

Successful response