Récupérer un groupe

Récupère un groupe par son ID.

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

Récupérer un groupe

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

Identifiant unique du groupe (généré par le service).

Required string length: 18 - 26

Réponse

200

application/json

Groupe récupéré avec succès.

Représente les métadonnées d’un groupe. Les listes de membres sont récupérées par un point de terminaison distinct.

created_at · string<date-time> · requis

Horodatage de création du groupe.

id · string · requis

Identifiant unique du groupe (généré par le service).

Required string length: 18 - 26

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

name · string · requis

Nom du groupe. Il doit être unique au sein de sa connexion. Il doit contenir entre 1 et 128 caractères ASCII imprimables.

Required string length: 1 - 128

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

tenant_name · string · requis

Identifiant du locataire auquel ce groupe appartient.

Minimum string length: 3

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

updated_at · string<date-time> · requis

Horodatage de la dernière mise à jour du groupe.

connection_id · string<connection-id>

Identifiant de la connexion à laquelle ce groupe appartient (s’il s’agit d’un groupe de connexion).

external_id · string

Identifiant externe du groupe, souvent utilisé pour la synchronisation SCIM. Longueur maximale : 256 caractères.

Maximum string length: 256