Obtener un grupo

Recupera un grupo por su ID.

GET https://{tenantDomain}/api/v2/groups/{id}

Obtener un Group

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/groups/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "tenant_name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "connection_id": "<string>",
  "external_id": "<string>"
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

id · string · requerido

Identificador único del grupo (generado por el servicio).

Required string length: 18 - 26

Respuesta

200

application/json

Grupo recuperado correctamente.

Representa los metadatos de un grupo. Las listas de miembros se recuperan mediante un endpoint independiente.

created_at · string<date-time> · requerido

Marca temporal de creación del grupo.

id · string · requerido

Identificador único del grupo (generado por el servicio).

Required string length: 18 - 26

Pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$

name · string · requerido

Nombre del grupo. Debe ser único dentro de su conexión. Debe contener entre 1 y 128 caracteres ASCII imprimibles.

Required string length: 1 - 128

Pattern: ^[\x20-\x7E]+$

tenant_name · string · requerido

Identificador del inquilino al que pertenece este grupo.

Minimum string length: 3

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$

updated_at · string<date-time> · requerido

Marca temporal de la última actualización del grupo.

connection_id · string<connection-id>

Identificador de la conexión a la que pertenece este grupo (si es un grupo de conexión).

external_id · string

Identificador externo del grupo, que suele usarse para la sincronización de SCIM. Longitud máxima: 256 caracteres.

Maximum string length: 256