1. Docs
  2. API Reference
  3. Create a group

Create a group

POST/scim/v2/directories/{directoryId}/Groups

SCIM 2.0 (RFC 7644 §3.3). Creates a group the identity provider pushes, with its members. Members receive a role only once an administrator maps the group to a role. Returns the SCIM Group resource with 201. Errors use SCIM's error schema (RFC 7644 §3.12).

Path Parameters

directoryIdstring Required

The directory the SCIM token was minted for.

Request body

application/json

schemasstring[] Optional
displayNamestring Required
externalIdstring Optional
membersScimMemberDto[] Optional

Responses

application/scim+json

  • schemasstring[]*
  • idstring*
  • externalIdstring
  • displayNamestring*
  • membersScimMemberDto[]*
  • metaScimMetaDto*

application/scim+json

  • schemasstring[]*
  • statusstring*

    The HTTP status, as a string

  • detailstring*
  • scimTypestring

    Present for some refusals, e.g. `uniqueness`

application/scim+json

  • schemasstring[]*
  • statusstring*

    The HTTP status, as a string

  • detailstring*
  • scimTypestring

    Present for some refusals, e.g. `uniqueness`

application/scim+json

  • schemasstring[]*
  • statusstring*

    The HTTP status, as a string

  • detailstring*
  • scimTypestring

    Present for some refusals, e.g. `uniqueness`

Returned object

ScimGroupDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/scim/v2/directories/value/Groups" \
  -H "Content-Type: application/json" \
  -d '{
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "displayName": "string",
    "externalId": "string",
    "members": [
      {
        "value": "string"
      }
    ]
  }'
Response
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "string",
  "externalId": "string",
  "displayName": "string",
  "members": [
    {
      "value": "string"
    }
  ],
  "meta": {
    "resourceType": "User",
    "created": "2026-04-20T12:00:00.000Z",
    "lastModified": "2026-04-20T12:00:00.000Z",
    "location": "string",
    "version": "string"
  }
}
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy