Method: groups.list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
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. |
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[],[],null,["# Method: groups.list\n\nRetrieves all groups of a domain or of a user given a userKey (paginated).\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/groups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customer` | `string` The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. |\n| `domain` | `string` The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. |\n| `maxResults` | `integer` Maximum number of results to return. Max allowed value is 200. |\n| `orderBy` | `enum (`[OrderBy](/workspace/admin/directory/reference/rest/v1/groups/list#OrderBy)`)` Column to use for sorting results |\n| `pageToken` | `string` Token to specify next page in the list |\n| `query` | `string` Query string search. Should be of the form \"\". Complete documentation is at https: //developers.google.com/workspace/admin/directory/v1/guides/search-groups |\n| `sortOrder` | `enum (`[SortOrder](/workspace/admin/directory/reference/rest/v1/groups/list#SortOrder)`)` Whether to return results in ascending or descending order. Only of use when orderBy is also used |\n| `userKey` | `string` Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object. Cannot be used with the `customer` parameter. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"groups\": [ { object (/workspace/admin/directory/reference/rest/v1/groups#Group) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Kind of resource this is. |\n| `etag` | `string` ETag of the resource. |\n| `groups[]` | `object (`[Group](/workspace/admin/directory/reference/rest/v1/groups#Group)`)` A list of group objects. |\n| `nextPageToken` | `string` Token used to access next page of this result. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/groups/`\n- `\n https://www.googleapis.com/auth/admin.directory.group`\n- `\n https://www.googleapis.com/auth/admin.directory.group.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nOrderBy\n-------\n\n| Enums ||\n|---------|---------------------|\n| `EMAIL` | Email of the group. |\n\nSortOrder\n---------\n\n| Enums ||\n|--------------|-------------------|\n| `ASCENDING` | Ascending order. |\n| `DESCENDING` | Descending order. |"]]
