Récupérer les groupes

Lister tous les groupes dans votre locataire.

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

Récupérer tous les groupes

cURL

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

200

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

connection_id · string

Filtrer les groupes par ID de connexion.

name · string

Filtrer les groupes par nom.

Required string length: 1 - 128

external_id · string

Filtrer les groupes par ID externe.

Maximum string length: 256

search · string

Rechercher des groupes par nom ou par ID externe.

Required string length: 1 - 256

fields · string

Liste de champs séparés par des virgules à inclure ou à exclure (selon include_fields) dans le résultat; laisser vide pour récupérer tous les champs

Maximum string length: 256

include_fields · boolean

Indique si les champs spécifiés doivent être inclus (true) ou exclus (false).

page · integer

Indice de la page de résultats à renvoyer. La première page est 0.

Plage requise: x >= 0

per_page · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

include_totals · boolean

Renvoyer les résultats dans un objet contenant le nombre total de résultats (true) ou sous forme de tableau de résultats direct (false, valeur par défaut).

from · string

Id facultatif à partir duquel commencer la sélection.

take · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

Réponse

200

application/json

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

object[]

object

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

connection_id · string<connection-id>

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

created_at · string<date-time>

Horodatage de création du groupe.

external_id · string

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

Maximum string length: 256

id · string

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

Nom du groupe. Doit être unique dans sa connexion. Doit contenir entre 1 et 128 caractères ASCII imprimables.

Required string length: 1 - 128

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

tenant_name · string

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>

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