Time	Status	User Agent
Retrieving recent requests…

Allows you to create a SCIM group in Capillary that represents a role in your organization. In SCIM, a group is the equivalent of a role, and creating a group maps it to an existing role configured for your org. This API is primarily used by identity providers to mirror their groups in Capillary, so that users belonging to those groups are automatically assigned the corresponding role and access on the Capillary platform.

Example request

curl --location 'https://eu.api.capillarytech.com/launchpad/api/v2/Groups' \
--header 'Authorization: Bearer a7ba38a39712dff766414c43ef23dbf3c8d5138fd9db3ec3916b09a7a48da0c3' \
--header 'Content-Type: application/scim+json' \
--data '{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
    "displayName": "MC AGENT"
  }'

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}.

Request body parameters

Field	Type	Required	Description
`schemas`	array	Yes	Declares the type of resource being sent. Must be `"urn:ietf:params:scim:schemas:core:2.0:Group"`.
`displayName`	string	Yes	The name of the group. This must exactly match an existing role name in your Capillary organization. Capillary uses this name to find and assign the corresponding role. For example, if your organization has a role named `MC AGENT`, the `displayName` must be `MC AGENT` (case-sensitive). To view the roles available in your organization, see Types of Users in the Organization. If no matching role is found, the request fails with a `400` error.
`members`	array	Optional	The list of users to be assigned to this group's role on the platform. Defaults to an empty array if not provided.
`members.value`	string	Optional	The identifier of the user to assign to this group. Accepts a numeric ID (e.g. `50795539`), a SCIM ID (e.g. `scim-1777291410320`), or an email address.
`members.$ref`	string	Optional	The URI reference pointing to the user's SCIM resource (e.g. `/launchpad/api/v2/Users/50795539`). Used by identity providers to reference the user's full SCIM path.
`members.type`	string	Optional	The type of member being added to the group. Supported value: `User`.
`externalId`	string	Optional	The identifier for this group in the identity provider (e.g. Azure AD group ID). Used to track and match the group during future sync operations. Defaults to `null` if not provided.

Example response

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "id": "group-2eb61740-7b69-4dfa-b3e2-d97d58f4cef4",
    "displayName": "MC AGENT",
    "members": [],
    "externalId": null,
    "roleId": 18518,
    "orgId": 1231
}

Response parameters

Field	Type	Description
`schemas`	array	Indicates the type of resource being returned. Always returns `"urn:ietf:params:scim:schemas:core:2.0:Group"`.
`id`	string	The unique ID assigned to the created group by Capillary. Generated in the format `group-{UUID}`. Used to identify the group in subsequent SCIM operations.
`displayName`	string	The name of the created group, matching the role name in your organisation that the group maps to.
`members`	array	The list of users assigned to this group as provided in the request. Returns an empty array if no members were provided.
`members.value`	string	The ID of the user assigned to this group.
`members.$ref`	string	The URI reference pointing to the assigned user's SCIM resource.
`members.type`	string	The type of member assigned to the group. Always returns `User`.
`externalId`	string or null	The identity provider identifier for this group. Returns `null` if not provided in the request.
`roleId`	number	The internal role ID in Capillary that this group maps to. Derived from the `displayName` passed in the request.
`orgId`	number	The organisation ID that this group belongs to. Derived from the Bearer token.

Error codes

Code	Type	Description
400	Error	`displayName` does not match any existing role configured for the org.
401	Error	`Authorization` header is missing or is not a valid Bearer token.
403	Error	Token is invalid or not associated with any org.