Method: groups.list

Récupère tous les groupes d'un domaine ou d'un utilisateur à partir d'une clé utilisateur (pagination).

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. L'customerId est également renvoyé dans la ressource Users. Vous devez fournir le paramètre customer ou domain.
domain

string

Nom de domaine. Utilisez ce champ pour n'obtenir que les groupes 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 à renvoyer. 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 de la liste
query

string

Recherche par chaîne de requête. Contient une ou plusieurs clauses de recherche, chacune avec un champ, un opérateur et une valeur. Pour obtenir la documentation complète, consultez Rechercher des groupes.
sortOrder

enum (SortOrder)

Détermine si les résultats doivent être renvoyés par ordre croissant ou décroissant. N'est utile que lorsque orderBy est également utilisé.
userKey

string

Adresse e-mail ou ID immuable de l'utilisateur si seuls les groupes dont l'utilisateur donné est membre doivent être listés. S'il s'agit d'un ID, il doit correspondre à celui de l'objet utilisateur. 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.

Niveaux d'accès 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 Ordre croissant.
DESCENDING Ordre décroissant.