Vous pouvez rechercher des groupes correspondant à certains attributs à l'aide de la méthode groups.list de l'API Directory. Cette méthode accepte le paramètre query, qui est une requête de recherche combinant une ou plusieurs clauses de recherche. Chaque clause de recherche se compose de trois parties:
- Champ
- Attribut de groupe recherché. Exemple :
name - Opérateur
- Test effectué sur les données pour fournir une correspondance. Par exemple, l'opérateur
=vérifie si un attribut de texte correspond à une valeur. - Valeur
- Contenu de l'attribut testé. Exemple :
groupName
Plusieurs clauses sont séparées par des espaces blancs et sont implicitement jointes par un opérateur AND.
Champs
| Champ | Type de valeur | Opérateurs | Description |
|---|---|---|---|
email |
chaîne | =, :{PREFIX}* |
Adresse e-mail du groupe. Remarque: Vous ne pouvez pas utiliser cette option avec le paramètre memberKey dans la même requête. |
name |
chaîne | =, :{PREFIX}* |
Nom à afficher du groupe. Remarque: Vous ne pouvez pas utiliser cette option avec le paramètre memberKey dans la même requête. |
memberKey |
chaîne | =, |
Le paramètre de requête memberKey renvoie tous les groupes auxquels un utilisateur ou un groupe appartient. Cette valeur peut être l'adresse e-mail principale ou d'alias de l'utilisateur, l'adresse e-mail principale ou d'alias d'un groupe, ou l'ID utilisateur unique. Remarque: Vous ne pouvez pas utiliser ce paramètre avec les paramètres email ou name dans la même requête. |
Types de valeurs
| Type de valeur | Remarques |
|---|---|
| chaîne | Placez la requête entre guillemets simples ' si elle contient des espaces. Échappez les guillemets simples dans les requêtes avec \', par exemple 'Valentine\'s Day'. |
Opérateurs
| Opérateur | Types de valeurs acceptés | Remarques |
|---|---|---|
= |
chaîne, booléen, nombre, date | Le champ et la valeur correspondent exactement. Par exemple, name=contact correspond à tous les groupes avec l'attribut name "contact", mais pas à "contactgroup". Compatible avec la plupart des champs de chaîne (voir ci-dessus). |
:{PREFIX}* |
chaîne | Le champ commence par la valeur. Par exemple, une requête avec email:support* correspond aux groupes dont les valeurs email sont "supportgroup@" et "support@", mais pas "contactsupport". Compatible uniquement avec un nombre limité de champs de chaîne (voir ci-dessus). |
Exemples
Toutes les requêtes utilisent la méthode groups.list, qui comporte une requête HTTP semblable à la suivante (les sauts de ligne sont inclus pour plus de lisibilité):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Les paramètres query doivent être encodés au format URL. Par exemple, la requête query=email:support* est encodée au format URL sous la forme query=email%3Asupport*.
Tous les exemples de cette page présentent des paramètres query non encodés.
Les bibliothèques clientes gèrent automatiquement cet encodage d'URL.
Rechercher un groupe par nom à afficher
name='contact'
Rechercher des groupes correspondant à un préfixe d'adresse e-mail
email:admin*
Rechercher tous les groupes d'un utilisateur
memberKey=user@company.com
Rechercher des groupes dont le nom et l'adresse e-mail commencent par contact
name:contact* email:contact*