Update a SCIM group

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "Platform 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": "Platform 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-02T00:00:00.000Z"
  }
}

PUT

scim

Groups

{workspace_team_id}

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "Platform 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": "Platform 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-02T00:00:00.000Z"
  }
}

Authorizations

Authorization

string

required

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

Path

workspace_team_id

string

required

The ID of the group to update.

Body

application/json

schemas

string[]

required

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

displayName

string

required

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

members

object[]

required

The complete new member list. This fully replaces the existing membership — members not included are removed.

Show members[]

value

string

required

Workspace membership ID or workspace invite ID of the member.

$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 group.

displayName

string

The updated display name of the group.

members

object[]

The updated member list.

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": "Platform 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": "Platform 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-02T00:00:00.000Z"
  }
}

List SCIM groups Patch a SCIM group

⌘I

Introduction

Guides

Tutorials

Attribute types

Endpoint reference

Webhook reference

Authorizations

Path

Body

Response

​Authorizations

​Path

Body

​Response

Authorizations

Path

Response