Updating a Google Group to a security group

Beta

This product is covered by the Pre-GA Offerings Terms of the Google Cloud Platform Terms of Service. Pre-GA products may have limited support, and changes to pre-GA products may not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

To create a security group, you must first create a Google Group, and then update that Google Group to a security group. This page explains how to update a Google Group to a security group.

Note: You must use the beta version of the Cloud Identity Groups API to create and manage security groups.

Before you begin

Perform the following tasks before proceeding with the information on this page:

• Read the Groups API overview.

• Read the dynamic groups overview.

• Set up the Groups API.

• As a Google Group Admin, create a Google Group.

Updating a Google Group to a security group

Security groups can only contain users, service accounts, and other security groups. Security groups cannot contain external groups, external groups that are security groups, or internal groups that aren't security groups. You cannot apply a label to a Google Group that doesn't meet these conditions.

Warning: A security group cannot be changed back to a Google Group.

REST

To update a Google Group to a security group, call groups.patch() with the label set to cloudidentity.googleapis.com/groups.security and cloudidentity.googleapis.com/groups.discussion_forum.

Python

The following example shows a helper function to update a Google Group to a security group using the Python client library:

def add_security_label_to_group(service, group_name):
  group = {
    "labels": {
      "cloudidentity.googleapis.com/groups.security": "",
      "cloudidentity.googleapis.com/groups.discussion_forum": ""
    }
  }
  try:
    request = service.groups().patch(name=group_name, body=group)
    request.uri = request.uri + '&updateMask=labels'
    response = request.execute()
    print(response)
  except Exception as e:
    print(e)

Send feedback