Skip to main content
PATCH
/
v1
/
groups
/
{group}
{
  "name": "<string>",
  "title": "<string>",
  "description": "<string>",
  "members": [
    {
      "member": "<string>",
      "role": "ROLE_UNSPECIFIED"
    }
  ],
  "source": "<string>"
}

Path Parameters

​
group
string
required

The group id.

Query Parameters

​
updateMask
string<field-mask>

The list of fields to update.

​
allowMissing
boolean

If set to true, and the group is not found, a new group will be created. In this situation, update_mask is ignored.

Body

application/json

A group of users within the workspace.

​
title
string

The display title of the group.

​
description
string

The description of the group.

​
members
object[]

The members of the group.

​
source
string

The source system where the group originated (e.g., Entra ID for SCIM sync).

Response

OK

A group of users within the workspace.

​
name
string

The name of the group to retrieve. Format: groups/{group}, group is an email.

​
title
string

The display title of the group.

​
description
string

The description of the group.

​
members
object[]

The members of the group.

​
source
string

The source system where the group originated (e.g., Entra ID for SCIM sync).