Skip to main content
POST
/
v1
/
groups
cURL
curl --request POST \
  --url https://api.example.com/v1/groups \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "members": [
    {
      "member": "<string>",
      "role": "ROLE_UNSPECIFIED"
    }
  ],
  "source": "<string>",
  "email": "<string>"
}
'
{
  "name": "<string>",
  "title": "<string>",
  "description": "<string>",
  "members": [
    {
      "member": "<string>",
      "role": "ROLE_UNSPECIFIED"
    }
  ],
  "source": "<string>",
  "email": "<string>"
}

Query Parameters

groupEmail
string

The email to use for the group, which will become the final component of the group's resource name.

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).

email
string

The unique email for the group.

Response

OK

A group of users within the workspace.

name
string

The name of the group to retrieve. Format: groups/{group}, the group should be email or uuid.

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).

email
string

The unique email for the group.