Method: groups.list

Récupère tous les groupes d'un domaine ou d'un utilisateur à l'aide d'une clé utilisateur (mise en page).

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

string

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 au lieu de domain. Vous pouvez également utiliser l'alias my_customer pour représenter le customerId de votre compte. Le customerId est également renvoyé dans le cadre de la ressource Users. Vous devez fournir le paramètre customer ou domain.
domain

string

Nom de domaine. Utilisez ce champ pour obtenir des groupes provenant d'un seul domaine. Pour renvoyer tous les domaines d'un compte client, utilisez plutôt le paramètre de requête customer.
maxResults

integer

Nombre maximal de résultats sur une page. La valeur maximale autorisée est de 200.
orderBy

enum (OrderBy)

Colonne à utiliser pour trier les résultats
pageToken

string

Jeton permettant de spécifier la page suivante dans la liste
query

string

Recherche de chaîne de requête Doit être au format "". Pour obtenir la documentation complète, consultez la page https://developers.google.com/admin-sdk/directory/v1/guides/search-groups.
sortOrder

enum (SortOrder)

Indique si les résultats doivent être renvoyés par ordre croissant ou décroissant. À utiliser uniquement lorsque "orderBy" est également utilisé
userKey

string

Adresse e-mail ou identifiant immuable de l'utilisateur si seuls les groupes dont il est membre doivent être listés. S'il s'agit d'un ID, il doit correspondre à l'ID de l'objet utilisateur. Il ne peut pas être utilisé avec le paramètre customer.

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 (Group)
    }
  ],
  "nextPageToken": string
}
Champs
kind

string

Type de ressource
etag

string

ETag de la ressource.
groups[]

object (Group)

Liste d'objets de groupe.
nextPageToken

string

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 d'autorisation.

OrderBy

Enums
EMAIL Adresse e-mail du groupe.

SortOrder

Enums
ASCENDING par ordre croissant.
DESCENDING Ordre décroissant.