Create a new SCIM group

post/scim/v2/Groups

Creates a new SCIM group. The displayName of the SCIM group must be set by the client within the request body.

Request Samples

1

Response Samples

1{
2 "id": "e2c9c521-6b7c-49d2-8fff-7a3df8c03cf4",
3 "displayName": "TestScimGroup1",
4 "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
5 "schemas": [
6 "urn:ietf:params:scim:schemas:core:2.0:Group"
7 ],
8 "meta": {
9 "resourceType": "Group",
10 "created": "2025-10-16T13:50:44.645Z",
11 "lastModified": "2025-10-16T13:50:44.645Z"
12 }
13}

Request Body

SCIM 2.0 Group resource for POST and PUT requests (group creation and updates). Note that id is server-generated and should not be included in requests.

NameTypeRequiredDescription
schemas
array [string]
true

SCIM schemas URN array.

id
string
false

Unique identifier for the group resource (SCIM ID).

<= 100 characters
displayName
string
true

A human-readable name for the group. This property is required.

<= 100 characters
Match pattern:
^(?!.*<[Ss][Cc][Rr][Ii][Pp][Tt][\s\S]*?>).*$
externalId
string
false

An identifier for the resource as defined by the provisioning client.

members
array [object]
false

A list of members of the group.

meta
object
false

Resource metadata.

undefined
false

Responses

StatusMeaningDescription
201Created

A new group was created.

HeadersSchema
400Bad Request

The request was invalid.

401Unauthorized

Authentication is required.

403Forbidden

The authenticated user does not have sufficient privileges.

Schema
409Conflict

The group could not be created because a group with the same ID already exists