Saltar al contenido

Create a SCIM group mapping

Módulo Settings

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.

  • Requiere la capacidad org.security.write.
  • Alcances de OAuth: org.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: ScimGroupMappingCreate

scimGroupMappings.create: ScimGroupMappingCreate
CampoTipoObligatorioDescripción
idp_groupstringSíIdentity-provider group name.Restricciones: length 1 to 300
role_idstring (uuid) | nullNoIdentifier of the role.
team_idstring (uuid) | nullNoIdentifier of the team.
identity_provider_idstring (uuid)Sí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"
}

Respuesta 201: ScimGroupMapping

scimGroupMappings.create: ScimGroupMapping
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the scim group mapping.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
idp_groupstringSíIdentity-provider group name.Restricciones: length 1 to 300
role_idstring (uuid) | nullSíIdentifier of the role.
team_idstring (uuid) | nullSíIdentifier of the team.
identity_provider_idstring (uuid)Sí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"
}

Ejemplos de código

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"}'