Create a SCIM group

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "Engineering",
  "members": [
    {
      "value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
    }
  ]
}

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "id": "b5d3f8a1-c920-47e6-8b4d-3f17a9c82e50",
  "displayName": "Engineering",
  "members": [
    {
      "value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
      "$ref": "/scim/v2/Users/3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2024-01-01T00:00:00.000Z",
    "lastModified": "2024-01-01T00:00:00.000Z"
  }
}

POST

scim

Groups

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "Engineering",
  "members": [
    {
      "value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
    }
  ]
}

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "id": "b5d3f8a1-c920-47e6-8b4d-3f17a9c82e50",
  "displayName": "Engineering",
  "members": [
    {
      "value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
      "$ref": "/scim/v2/Users/3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2024-01-01T00:00:00.000Z",
    "lastModified": "2024-01-01T00:00:00.000Z"
  }
}

Authorizations

Authorization

string

required

This API uses OAuth 2.0 with the authorization code grant flow.

Body

application/json

schemas

string[]

required

Must include "urn:ietf:params:scim:schemas:core:2.0:Group".

displayName

string

required

The display name of the group. Must be non-empty after trimming whitespace. Must be unique within the workspace.

members

object[]

Members to add to the group on creation. Each value may be a workspace membership ID (active user) or a workspace invite ID (pending user).

Show members[]

value

string

required

Workspace membership ID or workspace invite ID.

$ref

string

URI reference for the member resource.

type

string

The type of the member resource.

Response

schemas

string[]

Always ["urn:ietf:params:scim:schemas:core:2.0:Group"].

string

The unique ID of the created group.

displayName

string

The display name of the created group.

members

object[]

The members in the group.

Show members[]

value

string

Workspace membership ID or workspace invite ID.

$ref

string

URI reference in the form /scim/v2/Users/{id}.

meta

object

Show meta

resourceType

string

Always "Group".

created

string

ISO 8601 timestamp of when the group was created.

lastModified

string

ISO 8601 timestamp of when the group was last modified.

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "Engineering",
  "members": [
    {
      "value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
    }
  ]
}

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "id": "b5d3f8a1-c920-47e6-8b4d-3f17a9c82e50",
  "displayName": "Engineering",
  "members": [
    {
      "value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
      "$ref": "/scim/v2/Users/3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2024-01-01T00:00:00.000Z",
    "lastModified": "2024-01-01T00:00:00.000Z"
  }
}

Delete a SCIM user Get a SCIM group

⌘I

Introduction

Guides

Tutorials

Attribute types

Endpoint reference

Webhook reference

Authorizations

Body

Response

​Authorizations

Body

​Response

Authorizations

Response