Saltar al contenido

Get a SCIM group mapping

Módulo Settings

GET/scim-group-mappings/{id}scimGroupMappings.get

An identity-provider group mapped to a role or team. Returns one SCIM group mapping with its `ETag`. A SCIM group mapping the caller may not see returns 404.

  • Requiere la capacidad org.settings.read.
  • Alcances de OAuth: org.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

scimGroupMappings.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the scim group mapping.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: ScimGroupMapping

scimGroupMappings.get: 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 GET "$XOS_BASE_URL/scim-group-mappings/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.scimGroupMappings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.scim_group_mappings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos scim-group-mappings get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f