Method: groups.list

Recupera tutti i gruppi di un dominio o di un utente a partire da un valore userKey (paginato).

Richiesta HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
customer

string

L'ID univoco dell'account Google Workspace del cliente. In caso di un account multidominio, per recuperare tutti i gruppi di un cliente, utilizza questo campo anziché domain. Puoi anche utilizzare l'alias my_customer per rappresentare il customerId del tuo account. customerId viene restituito anche all'interno della risorsa Utenti. Devi fornire il parametro customer o domain.
domain

string

Il nome di dominio. Utilizza questo campo per ottenere gruppi da un solo dominio. Per restituire tutti i domini per un account cliente, utilizza il parametro di query customer.
maxResults

integer

Il numero massimo di risultati da restituire. Il valore massimo consentito è 200.
orderBy

enum (OrderBy)

Colonna da utilizzare per ordinare i risultati
pageToken

string

Token per specificare la pagina successiva nell'elenco
query

string

Ricerca nella stringa di query. Deve essere nel formato "". La documentazione completa è disponibile all'indirizzo https: //developers.google.com/workspace/admin/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

Indica se i risultati devono essere restituiti in ordine crescente o decrescente. Da utilizzare solo se viene utilizzato anche orderBy
userKey

string

Indirizzo email o ID immutabile dell'utente se devono essere elencati solo i gruppi di cui l'utente fa parte. Se si tratta di un ID, deve corrispondere all'ID dell'oggetto utente. Non può essere utilizzato con il parametro customer.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
Campi
kind

string

Il tipo di risorsa.
etag

string

ETag della risorsa.
groups[]

object (Group)

Un elenco di oggetti gruppo.
nextPageToken

string

Token utilizzato per accedere alla pagina successiva di questo risultato.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • 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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

OrderBy

Enum
EMAIL Indirizzo email del gruppo.

SortOrder

Enum
ASCENDING Ordine crescente.
DESCENDING Ordine decrescente.