Récupère tous les groupes d'un domaine ou d'un utilisateur à partir d'un userKey (paginé).
Requête HTTP
GET https://admin.googleapis.com/admin/directory/v1/groups
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de requête
Paramètres | |
---|---|
customer |
Identifiant unique du compte Google Workspace du client. Dans le cas d'un compte multidomaine, pour récupérer tous les groupes d'un client, utilisez ce champ à la place de |
domain |
Nom de domaine. Utilisez ce champ pour obtenir les groupes d'un seul domaine. Pour renvoyer tous les domaines d'un compte client, utilisez plutôt le paramètre de requête |
maxResults |
Nombre maximal de résultats sur une page. La valeur maximale autorisée est de 200. |
orderBy |
Colonne à utiliser pour trier les résultats |
pageToken |
Jeton permettant de spécifier la page suivante dans la liste |
query |
Recherche de chaîne de requête Doit être au format " |
sortOrder |
Indique si les résultats doivent être affichés dans l'ordre croissant ou décroissant. À utiliser uniquement lorsque orderBy est également utilisé |
userKey |
Adresse e-mail ou identifiant immuable de l'utilisateur si seuls ces groupes doivent être répertoriés, l'utilisateur en question est membre. S'il s'agit d'un ID, il doit correspondre à l'ID de l'objet utilisateur. |
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :
Représentation JSON |
---|
{
"kind": string,
"etag": string,
"groups": [
{
object ( |
Champs | |
---|---|
kind |
Type de ressource dont il s'agit. |
etag |
ETag de la ressource. |
groups[] |
Une liste d'objets de groupe. |
nextPageToken |
Jeton utilisé pour accéder à la page suivante de ce résultat. |
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://apps-apis.google.com/a/feeds/groups/
https://www.googleapis.com/auth/admin.directory.group
https://www.googleapis.com/auth/admin.directory.group.readonly
Pour en savoir plus, consultez le guide relatif aux autorisations.
OrderBy
Enums | |
---|---|
EMAIL |
Adresse e-mail du groupe. |
SortOrder
Enums | |
---|---|
ASCENDING |
Ordre croissant. |
DESCENDING |
Ordre décroissant. |