Method: groups.list

Recupera tutti i gruppi di un dominio o di un utente a cui è stato assegnato un userKey (impaginato).

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
customer

string

L'ID univoco dell'account Google Workspace del cliente. Nel caso di un account con più domini, per recuperare tutti i gruppi per un cliente utilizza questo campo anziché domain. Puoi anche utilizzare l'alias my_customer per rappresentare le customerId del tuo account. customerId viene restituito anche come parte della risorsa Users. Devi fornire il parametro customer o domain.
domain

string

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

integer

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 per stringa di query. Deve essere nel formato "". La documentazione completa è disponibile all'indirizzo https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

Indica se restituire i risultati in ordine crescente o decrescente. Da utilizzare solo quando viene utilizzato anche orderBy
userKey

string

Indirizzo email o ID immutabile dell'utente se devono essere elencati solo i gruppi di cui l'utente è membro. Se si tratta di un ID, deve corrispondere all'ID dell'oggetto utente.

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 alle autorizzazioni.

OrderBy

Enum
EMAIL Indirizzo email del gruppo.

SortOrder

Enum
ASCENDING Ordine crescente.
DESCENDING Ordine decrescente.