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

Rechercher des groupes par nom ou par ID externe.

Required string length: 1 - 256
fields
string

Une 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 précisés doivent être inclus (true) ou exclus (false).

page
integer
deprecated

Index de la page de résultats à retourner. La première page est 0. La pagination par décalage est limitée à un maximum de 1,000 résultats; utilisez plutôt la pagination par point de contrôle (from et take).

Plage requise: x >= 0
per_page
integer
deprecated

Nombre de résultats par page. La valeur par défaut est 50. La pagination par décalage est limitée à un maximum de 1,000 résultats; utilisez plutôt la pagination par point de contrôle (from et take).

Plage requise: 1 <= x <= 100
include_totals
boolean
deprecated

Retourner les résultats dans un objet contenant le nombre total de résultats (true) ou sous forme de tableau direct de résultats (false, par défaut). Le total retourné ne dépasse pas 1,000 résultats.

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.

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]+$
external_id
string

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

Maximum string length: 256
connection_id
string<connection-id>

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

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])?$
created_at
string<date-time>

Horodatage de la création du groupe.

updated_at
string<date-time>

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