Time	Status	User Agent
Retrieving recent requests…

This API allows you to update a group by adding or removing members. Use this API when a user is added to or removed from a group in your identity provider, and you need to reflect that change in Intouch. When a member is added, they are automatically assigned the role the group maps to in Intouch. When a member is removed, that role is revoked, keeping your identity provider and Intouch in sync.

Example request

curl --location --request PATCH 'https://eu.api.capillarytech.com/launchpad/api/v2/Groups/group-b4ca8dbc-5a46-4946-bda9-cf1d7284f80e' \
--header 'Authorization: Bearer cf20eaf1a6e55a88560270461932efdad1f407ed3ba201c12f9dc097fa5cf35c' \
--header 'Content-Type: application/scim+json' \
--data '{
      "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
      "Operations": [
        {
          "op": "add",
          "path": "members",
          "value": [
            { "value": "scim-1780487313052" }
          ]
        }
      ]
    }'

curl --location --request PATCH 'https://eu.api.capillarytech.com/launchpad/api/v2/Groups/group-b4ca8dbc-5a46-4946-bda9-cf1d7284f80e' \
--header 'Authorization: Bearer cf20eaf1a6e55a88560270461932efdad1f407ed3ba201c12f9dc097fa5cf35c' \
--header 'Content-Type: application/scim+json' \
--data '{
      "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
      "Operations": [
        {
          "op": "add",
          "path": "members",
          "value": [
            { "value": "scim-1780487682307" },
            { "value": "scim-1780555209515" }
          ]
        }
      ]
    }'

curl --location --request PATCH 'https://eu.api.capillarytech.com/launchpad/api/v2/Groups/group-b4ca8dbc-5a46-4946-bda9-cf1d7284f80e' \
--header 'Authorization: Bearer cf20eaf1a6e55a88560270461932efdad1f407ed3ba201c12f9dc097fa5cf35c' \
--header 'Content-Type: application/scim+json' \
--data '{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
      {
        "op": "remove",
        "path": "members",
        "value": [
          { "value": "scim-1780487313052" }
        ]
      }
    ]
  }'

curl --location --request PATCH 'https://eu.api.capillarytech.com/launchpad/api/v2/Groups/group-b4ca8dbc-5a46-4946-bda9-cf1d7284f80e' \
--header 'Authorization: Bearer cf20eaf1a6e55a88560270461932efdad1f407ed3ba201c12f9dc097fa5cf35c' \
--header 'Content-Type: application/scim+json' \
--data '{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
      {
        "op": "remove",
        "path": "members",
        "value": [
          { "value": "scim-1780487682307" },
          { "value": "scim-1780555209515" }
        ]
      }
    ]
  }'

Prerequisites

A valid SCIM bearer token for your organization, generated using the Create SCIM Token API. Pass it in the request header as Authorization: Bearer {token}.

Path parameters

Field	Type	Required	Description
id	String	Yes	The unique SCIM ID of the group to update. This is returned when the group is created. For example, `group-56b8332d-3145-42e1-a28c-99e13005aa1f`.

Request body parameters

Field	Type	Required	Description
schemas	Array	Yes	Identifies this request as a SCIM partial update. Must be `urn:ietf:params:scim:api:messages:2.0:PatchOp`.
Operations	Array	Yes	List of operations to apply to the group. Multiple operations can be sent in a single request.
Operations.op	String	Yes	The action to perform. Use `add` to add members to the group, `remove` to remove members, or `replace` to update the group name or replace the members list entirely. Case-insensitive.
Operations.path	String	Yes	The field on the group to apply the operation to. Use `members` to add or remove users, or `displayName` to update the group name.
Operations.value	Array	Yes	The members to add or remove. Each entry represents a user to be added or removed from the group.
Operations.value.value	String	Yes	The SCIM user ID of the member being added or removed from the group.

Example response

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "id": "group-b4ca8dbc-5a46-4946-bda9-cf1d7284f80e",
    "displayName": "Group Name",
    "members": [
        {
            "value": "scim-1780487313052"
        }
    ],
    "externalId": null,
    "roleId": 18519,
    "orgId": 1231
}

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "id": "group-b4ca8dbc-5a46-4946-bda9-cf1d7284f80e",
    "displayName": "Group Name",
    "members": [
        {
            "value": "scim-1780487682307"
        },
        {
            "value": "scim-1780555209515"
        }
    ],
    "externalId": null,
    "roleId": 18519,
    "orgId": 1231
}

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "id": "group-b4ca8dbc-5a46-4946-bda9-cf1d7284f80e",
    "displayName": "Group Name",
    "members": [],
    "externalId": null,
    "roleId": 18519,
    "orgId": 1231
}

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "id": "group-b4ca8dbc-5a46-4946-bda9-cf1d7284f80e",
    "displayName": "Group Name",
    "members": [],
    "externalId": null,
    "roleId": 18519,
    "orgId": 1231
}

Response parameters

Field	Type	Description
schemas	Array	Identifies the SCIM resource type of the updated group. Returns `urn:ietf:params:scim:schemas:core:2.0:Group`.
id	String	The unique SCIM ID of the group that was updated.
displayName	String	The name of the group, which maps to a role in Intouch.
members	Array	The current list of members in the group after the patch operations were applied.
members.value	String	The user ID of the member remaining in the group.
externalId	String	The external identifier for the group from the identity provider. Returns `null` if not set.
roleId	Number	The ID of the Intouch role this group is mapped to. Members added to the group are assigned this role; members removed have it revoked.
orgId	Number	The ID of the organization this group belongs to.

Error codes

Code	Type	Description
400	Error	Organization context is missing from the SCIM token.
400	Error	The group's `displayName` does not map to a valid role in Intouch.
404	Error	No group found for the provided `id`.