API Directory: membri del gruppo

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