API Directory: membri del gruppo
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Aggiungere un membro a un gruppo
Per aggiungere un membro a un gruppo, utilizza la seguente richiesta POST e includi l'autorizzazione descritta nell'articolo relativo all'autorizzazione delle richieste. Un membro di un gruppo può essere un utente o un altro gruppo. groupKey è l'indirizzo email del gruppo del nuovo membro o il id univoco del gruppo. Per le proprietà di richiesta e risposta, consulta il riferimento API:
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
Se aggiungi un gruppo come membro di un altro gruppo, potrebbe essere necessario attendere fino a 10 minuti prima che i membri del gruppo secondario vengano visualizzati come membri del gruppo principale. Inoltre, l'API restituisce un errore per i cicli negli abbonamenti ai gruppi. Ad esempio, se il gruppo1 è membro del gruppo2, il gruppo2 non può essere membro del gruppo1.
Richiesta JSON
La seguente richiesta JSON mostra un corpo di richiesta di esempio che crea un membro del gruppo. L'indirizzo email del membro è liz@example.com e il suo ruolo nel gruppo è MEMBER. La richiesta POST utilizza NNNNN per groupKey:
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
"email": "liz@example.com",
"role": "MEMBER"
}
Il role di un membro del gruppo può essere:
OWNER: questo ruolo può modificare i messaggi inviati al gruppo, aggiungere o rimuovere membri, modificare i ruoli dei membri, modificare le impostazioni del gruppo ed eliminare il gruppo. Un OWNER deve essere un membro del gruppo.
MANAGER: questo ruolo è disponibile solo se Google Workspace è attivato utilizzando la Console di amministrazione. Un ruolo GESTIONE può eseguire tutte le operazioni di un ruolo PROPRIETARIO, ad eccezione di promuovere un membro a PROPRIETARIO o eliminare il gruppo. Un gruppo può avere più membri con ruolo PROPRIETARIO e GESTORE.
MEMBER: questo ruolo può iscriversi a un gruppo, visualizzare gli archivi delle discussioni e l'elenco dei membri del gruppo. Per ulteriori informazioni sui ruoli dei membri, visita il Centro assistenza per l'amministrazione.
Risposta JSON
Una risposta corretta restituisce un codice di stato HTTP 200 e i dati dell'abbonamento dell'utente. id è l'ID abbonamento univoco dell'abbonato:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MEMBER",
"type": "GROUP"
}
Il type di un membro di un gruppo può essere:
GROUP: il membro è un altro gruppo.MEMBER: il membro è un utente
Aggiornare l'appartenenza a un gruppo
Per aggiornare l'appartenenza a un gruppo, utilizza la seguente richiesta PUT e includi l'autorizzazione descritta nell'articolo relativo all'autorizzazione delle richieste. groupKey è l'indirizzo email del gruppo o il id univoco del gruppo, mentre memberKey è l'indirizzo email principale dell'utente o del gruppo, l'indirizzo email alias di un utente o il id univoco dell'utente. Per le proprietà di richiesta e risposta, consulta il riferimento API:
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Richiesta JSON
La seguente richiesta JSON mostra un corpo della richiesta di esempio che aggiorna le impostazioni di appartenenza a un gruppo. L'indirizzo email del membro è liz@example.com e il suo ruolo nel gruppo viene modificato da MEMBER a MANAGER. Il valore groupKey della richiesta PUT in questo esempio è NNNNN. Per informazioni sui ruoli MEMBER, OWNER e MANAGER, visita il Centro assistenza amministrazione:
PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
"email": "liz@example.com",
"role": "MANAGER"
}
Risposta JSON
Una risposta corretta restituisce un codice di stato HTTP 200 e i dati dell'abbonamento aggiornati. id è l'ID abbonamento univoco dell'abbonato:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Recuperare un membro di un gruppo
Per recuperare l'appartenenza a un gruppo, utilizza la seguente richiesta GET e includi l'autorizzazione descritta nell'articolo relativo all'autorizzazione delle richieste. groupKey è l'indirizzo email del gruppo o il id univoco del gruppo e memberKey è l'indirizzo email principale dell'utente o del gruppo, l'indirizzo email alias di un utente o il id univoco dell'utente. Per le proprietà di richiesta e risposta, consulta il riferimento API:
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Risposta JSON
Una risposta corretta restituisce un codice di stato HTTP 200 e i dati dell'abbonamento dell'utente. id è l'ID abbonamento univoco dell'abbonato:
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
Recuperare tutti i membri del gruppo
Per recuperare tutti i membri del gruppo, utilizza la seguente richiesta GET e includi l'autorizzazione descritta nell'articolo relativo all'autorizzazione delle richieste. groupKey è l'indirizzo email del gruppo o il id univoco del gruppo. La stringa di query facoltativa roles è un filtro che consente di recuperare i membri del gruppo in base al ruolo e le raccolte di ruoli risultanti sono nell'ordine specificato nel filtro roles. Per le proprietà di richiesta e risposta, consulta il riferimento API. Per favorire la leggibilità, in questo esempio sono stati inseriti dei ritorni a capo.
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
?pageToken=pagination token
&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma
&maxResults=maximum results per response page
Tutti i membri vengono restituiti in ordine alfabetico in base ai loro indirizzi email. Utilizza la stringa di query pageToken per le risposte con un numero elevato di membri. In caso di paginazione, la risposta restituisce la proprietà nextPageToken che contiene un token per la pagina successiva dei risultati della risposta. La richiesta successiva utilizza questo token come valore della stringa di query pageToken.
Risposta JSON
Una risposta corretta restituisce un codice di stato HTTP 200 e l'elenco delle informazioni sui membri. id è l'ID univoco dell'abbonamento del membro. In questa risposta è presente un nextPageToken per l'elenco aggiuntivo dei membri del gruppo:
{
"kind": "directory#members",
"members": [
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "USER"
},
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "radhe@example.com",
"role": "MANAGER",
"type": "USER"
}
],
"nextPageToken": "NNNNN"
}
Eliminare l'appartenenza a un gruppo
Per eliminare l'appartenenza di un membro a un gruppo, utilizza la seguente richiesta DELETE e includi l'autorizzazione descritta nell'articolo relativo all'autorizzazione delle richieste. groupKey è il id univoco del gruppo e memberKey è l'indirizzo email principale dell'utente o del membro del gruppo eliminato o il id univoco dell'utente. Per le proprietà di richiesta e risposta, consulta il riferimento API.
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Ad esempio, questa richiesta DELETE elimina il membro il cui groupKey è nnn e il cui memberKey è l'indirizzo email principale dell'utente, liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com
Una risposta riuscita restituisce un codice di stato HTTP 200.
Quando un membro viene eliminato:
- I membri rimossi non ricevono più le email indirizzate al gruppo.
- La rimozione di un membro da un gruppo non comporta l'eliminazione del suo account utente.
- Se elimini il proprietario del gruppo, il gruppo continuerà a funzionare normalmente. In qualità di amministratore, puoi gestire il gruppo o assegnare la proprietà a un altro membro del gruppo
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-08-29 UTC.
[null,null,["Ultimo aggiornamento 2025-08-29 UTC."],[],[],null,["# Directory API: Group Members\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1. [Add a member to a group](#create_member) 2. [Update a group membership](#update_member) 3. [Retrieve a group's member](#get_member) 4. [Retrieve all group members](#get_all_members) 5. [Delete membership in a group](#delete_member) |\n\nAdd a member to a group\n-----------------------\n\nTo add a member to a group, use the following `POST` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). A group member can be a user or another group. The `groupKey` is the new member's group email address or the group's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/insert): \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n```\n\nIf you add a group as a member of another group, there may be a delay of up to 10 minutes before the child group's members appear as members of the parent group. In addtion, the API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1.\n\n### JSON request\n\nThe following JSON request shows a sample request body that creates a group member. The member's email address is liz@example.com and the member's role in the group is as a `MEMBER`. The `POST` request uses NNNNN for the `groupKey`: \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\"\n}\n```\n\nA group member's `role` can be:\n\n- `OWNER` -- This role can change send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An `OWNER` must be a member of the group.\n- `MANAGER` -- This role is only available if the Google Workspace is enabled using the Admin console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple OWNER and MANAGER members.\n- `MEMBER` -- This role can subscribe to a group, view discussion archives, and view the group's membership list. For more information about member roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094).\n\n\u003cbr /\u003e\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\",\n \"type\": \"GROUP\"\n }\n```\n\nA group member's `type` can be:\n\n- `GROUP` -- The member is another group.\n- `MEMBER` -- The member is a user\n\n\u003cbr /\u003e\n\nUpdate a group membership\n-------------------------\n\nTo update a group membership, use the following `PUT` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/update): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n| **Note:** The API also supports the [patch semantics](/workspace/admin/directory/v1/guides/performance#patch).\n\n### JSON request\n\nThe following JSON request shows a sample request body that updates a group membership settings. The member's email address is liz@example.com and the member's role in the group is changed from a `MEMBER` to a `MANAGER`. The `PUT` request's `groupKey` in this example is NNNNN. For information about the MEMBER, OWNER and MANAGER roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\"\n}\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the updated membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve a group's member\n-------------------------\n\nTo retrieve a group membership, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/get): \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve all group members\n--------------------------\n\nTo retrieve all group members, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`. The optional `roles` query string is a filter allowing you to retrieve group members by role and the resulting role collections are in the order given in the `roles` filter. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/list). For readability, this example uses line returns: \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n?pageToken=pagination token\n&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma\n&maxResults=maximum results per response page\n```\n\nAll members are returned in the alphabetical order of the members' email addresses. And use the `pageToken` query string for responses with large number of members. In the case of pagination, the response returns the `nextPageToken` property which has a token for the next page of response results. Your next request uses this token as the `pageToken` query string value.\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the list of member information. The `id` is the member's unique membership ID. There is a `nextPageToken` for the follow-on list of group members in this response: \n\n```carbon\n{\n \"kind\": \"directory#members\",\n \"members\": [\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n },\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"radhe@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n }\n ],\n \"nextPageToken\": \"NNNNN\"\n}\n```\n\nDelete membership in a group\n----------------------------\n\nTo delete a member's membership in a group, use the following `DELETE` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's unique `id`, and `memberKey` is the deleted user or group member's primary email address or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/delete).: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\nFor example, this `DELETE` request deletes the member whose `groupKey` is nnn and whose `memberKey` is the user's primary email address, liz@example.com: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com\n```\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes).\n\nWhen a member is deleted:\n\n- Members you remove no longer receive email addressed to the group.\n- Removing a member from a group does not delete the user's account.\n- If you delete the group owner, the group still works normally. As an administrator, you can manage the group or assign ownership to another group member\n\n\u003cbr /\u003e"]]
