Skip to main content
GET
C#

Autorisations

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

ID de l’utilisateur pour lequel lister les groupes.

Paramètres de requête

fields
string

Liste de champs séparés par des virgules à inclure ou à exclure (selon include_fields) du résultat; laissez 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

Index 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 la forme d’un tableau direct de résultats (false, 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

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

Représente les métadonnées d’un groupe. Les listes de membres sont récupérées au moyen d’un endpoint 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 la 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 tenant 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.

membership_created_at
string<date-time>

Horodatage de l’ajout de l’appartenance au groupe.