Updating a Google Group to a security group

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.

Before you begin

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

Read the Groups API 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 the following:

users inside or outside of your domain
service accounts inside or outside of your domain
security groups inside of your domain

You can't apply the security group label to a Google Group that doesn't meet these conditions.

Only predefined Super Admins or Groups Admins have the permissions to update security groups.

REST

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

Sample request body

{
  "labels": {
    "cloudidentity.googleapis.com/groups.security": "",
    "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)