API Directory: Membri dei gruppi

Aggiungere un membro a un gruppo

Per aggiungere un membro a un gruppo, usa la seguente richiesta POST e includi l'autorizzazione descritta in Autorizzare le richieste. Un membro del gruppo può essere un utente o un altro gruppo. groupKey è l'indirizzo email del gruppo del nuovo membro o l'indirizzo email univoco del gruppo id. Per le proprietà richiesta e risposta, consulta la documentazione di riferimento API: 

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members

Se aggiungi un gruppo come membro di un altro gruppo, potrebbe verificarsi un ritardo di massimo 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 delle iscrizioni ai gruppi. Ad esempio, se il gruppo1 è membro di gruppo2, il gruppo2 non può essere membro del gruppo1.

Richiesta JSON

La seguente richiesta JSON mostra un corpo della richiesta di esempio che crea un membro del gruppo. L'indirizzo email del membro è liz@example.com e il ruolo del membro 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"
}

Le role di un membro del gruppo possono essere:

  • OWNER - Questo ruolo può modificare l'invio di messaggi al gruppo, aggiungere o rimuovere membri, modificare i ruoli dei membri, modificare le impostazioni del gruppo ed eliminare il gruppo. Un OWNER deve essere membro del gruppo.
  • MANAGER - Questo ruolo è disponibile solo se Google Workspace viene attivato utilizzando la Console di amministrazione. Un ruolo MANAGER può eseguire tutte le operazioni relative al ruolo di PROPRIETARIO, ma non può assegnare a un membro il ruolo di PROPRIETARIO o eliminare il gruppo. Un gruppo può avere più membri OWNER e MANAGER.
  • MEMBER: questo ruolo può iscriversi a un gruppo, visualizzare gli archivi delle discussioni e visualizzare l'elenco dei membri del gruppo. Per ulteriori informazioni sui ruoli dei membri, consulta il Centro assistenza per l'amministrazione.

Risposta JSON

Una risposta corretta restituisce un codice di stato HTTP 200 e le informazioni sull'appartenenza al membro. id è l'ID membro univoco dell'abbonato: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MEMBER",
   "type": "GROUP"
  }

Le type di un membro del gruppo possono essere:

  • GROUP - Il membro è un altro gruppo.
  • MEMBER - Il membro è un utente

Aggiornare l'iscrizione a un gruppo

Per aggiornare l'iscrizione a un gruppo, usa la seguente richiesta PUT e includi l'autorizzazione descritta in Autorizzare le richieste. groupKey è l'indirizzo email del gruppo o id univoco del gruppo e memberKey è l'indirizzo email principale dell'utente o del gruppo, l'indirizzo email alias di un utente o l'indirizzo email id univoco dell'utente. Per le proprietà richiesta e risposta, consulta la documentazione di riferimento API: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

Richiesta JSON

La seguente richiesta JSON mostra un esempio di corpo della richiesta che aggiorna le impostazioni di appartenenza a un gruppo. L'indirizzo email del membro è liz@example.com e il ruolo del membro 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, consulta il Centro assistenza per l'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 le informazioni aggiornate sull'iscrizione. id è l'ID membro univoco dell'abbonato: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Recupera il membro di un gruppo

Per recuperare l'iscrizione a un gruppo, usa la seguente richiesta GET e includi l'autorizzazione descritta in Autorizzare le richieste. groupKey è l'indirizzo email del gruppo o id univoco del gruppo e memberKey è l'indirizzo email principale dell'utente o del gruppo, l'indirizzo email alias di un utente o l'indirizzo email id univoco dell'utente. Per le proprietà richiesta e risposta, consulta la documentazione di 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 le informazioni sull'appartenenza al membro. id è l'ID membro univoco dell'abbonato: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Recupera tutti i membri del gruppo

Per recuperare tutti i membri del gruppo, usa la seguente richiesta GET e includi l'autorizzazione descritta in Autorizzare le richieste. groupKey è l'indirizzo email del gruppo o l'indirizzo id univoco del gruppo. La stringa di query roles facoltativa è un filtro che ti 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 la documentazione di riferimento API. Per la leggibilità, in questo esempio vengono utilizzati i ritorni a riga: 

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. Inoltre, utilizza la stringa di query pageToken per le risposte con un numero elevato di membri. In caso di impaginazione, la risposta restituisce la proprietà nextPageToken che ha un token per la pagina successiva dei risultati della risposta. La prossima richiesta utilizzerà questo token come valore della stringa di query pageToken.

Risposta JSON

Una risposta corretta restituisce un codice di stato HTTP 200 e l'elenco di informazioni sui membri. id è l'ID membro univoco dell'abbonato. C'è un nextPageToken per l'elenco di membri del gruppo di follow-on in questa risposta: 

{
   "kind": "directory#members",
   "members": [
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "liz@example.com",
    "role": "MANAGER",
    "type": "GROUP"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "MEMBER"
   }
  ],
   "nextPageToken": "NNNNN"
}

Eliminare l'appartenenza a un gruppo

Per eliminare la partecipazione di un membro a un gruppo, usa la seguente richiesta DELETE e includi l'autorizzazione descritta in Autorizzare richieste. groupKey è l'indirizzo email univoco del gruppo (id) e memberKey è l'indirizzo email principale dell'utente o del membro del gruppo eliminato o l'indirizzo email univoco dell'utente (id). Per le proprietà di richiesta e risposta, consulta la documentazione di 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 corretta restituisce un codice di stato HTTP 200.

Quando un membro viene eliminato:

  • I membri rimossi non riceveranno più le email indirizzate al gruppo.
  • La rimozione di un membro da un gruppo non elimina il suo account utente.
  • Se elimini il proprietario del gruppo, il gruppo continuerà a funzionare normalmente. In qualità di amministratore, puoi gestire il gruppo o assegnarne la proprietà a un altro membro del gruppo.