Skip to main content
POST
Create user group

Authorizations

Authorization
string
header
required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Body

application/json
displayName
string
required

The name of the group. Names must be 64 characters or less.

Example:

"Blob Sales"

members
object[]

A list of users to add as group members. Each member should be specified as an object containing a user ID.

Example:

Response

Group created successfully

id
string

Unique identifier for the group

displayName
string

The name of the group

members
object[]

The list of users in the group

meta
object

Metadata about the group resource

schemas
string[]

SCIM schema information for the group