Create a SCIM group mapping
Settings module
POST/scim-group-mappingsscimGroupMappings.create
An identity-provider group mapped to a role or team. Creates a SCIM group mapping. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability org.security.write.
- OAuth scopes: org.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: ScimGroupMappingCreate
| Field | Type | Required | Description |
|---|---|---|---|
| idp_group | string | Yes | Identity-provider group name.Constraints: length 1 to 300 |
| role_id | string (uuid) | null | No | Identifier of the role. |
| team_id | string (uuid) | null | No | Identifier of the team. |
| identity_provider_id | string (uuid) | Yes | Identifier of the identity provider. |
{
"idp_group": "event-finance",
"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"identity_provider_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: ScimGroupMapping
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the scim group mapping. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| idp_group | string | Yes | Identity-provider group name.Constraints: length 1 to 300 |
| role_id | string (uuid) | null | Yes | Identifier of the role. |
| team_id | string (uuid) | null | Yes | Identifier of the team. |
| identity_provider_id | string (uuid) | Yes | Identifier of the identity provider. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"idp_group": "event-finance",
"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"identity_provider_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/scim-group-mappings" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"idp_group":"event-finance","role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","identity_provider_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.scimGroupMappings.create({
"idp_group": "event-finance",
"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"identity_provider_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.scim_group_mappings.create({"idp_group": "event-finance", "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "identity_provider_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos scim-group-mappings create --data '{"idp_group":"event-finance","role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","identity_provider_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'