Directory API: Gruppenmitglieder

Einer Gruppe ein Mitglied hinzufügen

Wenn Sie einer Gruppe ein Mitglied hinzufügen möchten, verwenden Sie die folgende POST-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. Ein Gruppenmitglied kann ein Nutzer oder eine andere Gruppe sein. groupKey ist die Gruppen-E-Mail-Adresse des neuen Mitglieds oder die eindeutige id der Gruppe. Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz: 

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

Wenn Sie eine Gruppe als Mitglied einer anderen Gruppe hinzufügen, kann es bis zu 10 Minuten dauern, bis die Mitglieder der untergeordneten Gruppe als Mitglieder der übergeordneten Gruppe angezeigt werden. Außerdem gibt die API einen Fehler für Zyklen in Gruppenmitgliedschaften zurück. Wenn beispielsweise „group1“ Mitglied von „group2“ ist, kann „group2“ nicht Mitglied von „group1“ sein.

JSON-Anfrage

Die folgende JSON-Anfrage zeigt einen Beispielanfragetext, mit dem ein Gruppenmitglied erstellt wird. Die E‑Mail-Adresse des Mitglieds ist liz@beispiel.de und die Rolle des Mitglieds in der Gruppe ist MEMBER. Bei der POST-Anfrage wird NNNNN für groupKey verwendet: 

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

{
   "email": "liz@example.com",
    "role": "MEMBER"
}

Die role eines Gruppenmitglieds kann Folgendes sein:

  • OWNER: Diese Rolle kann Nachrichten an die Gruppe senden, Mitglieder hinzufügen oder entfernen, Mitgliedsrollen ändern, Gruppeneinstellungen ändern und die Gruppe löschen. Ein OWNER muss Mitglied der Gruppe sein.
  • MANAGER: Diese Rolle ist nur verfügbar, wenn Google Workspace über die Admin-Konsole aktiviert ist. Mit der Rolle „MANAGER“ können alle Aktionen ausgeführt werden, die auch mit der Rolle „OWNER“ möglich sind. Ausnahmen: Ein Mitglied kann nicht zum „OWNER“ gemacht und die Gruppe nicht gelöscht werden. Eine Gruppe kann mehrere Mitglieder mit der Rolle INHABER und MANAGER haben.
  • MEMBER: Mit dieser Rolle können Nutzer eine Gruppe abonnieren, Diskussionsarchive und die Mitgliederliste der Gruppe ansehen. Weitere Informationen zu Mitgliedsrollen finden Sie in der Administratorhilfe.

JSON-Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Mitgliedschaftsinformationen des Mitglieds zurückgegeben. Die id ist die eindeutige Mitgliedschafts-ID des Mitglieds: 

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

Die type eines Gruppenmitglieds kann Folgendes sein:

  • GROUP: Das Mitglied ist eine andere Gruppe.
  • MEMBER: Das Mitglied ist ein Nutzer.

Gruppenmitgliedschaft aktualisieren

Wenn Sie eine Gruppenmitgliedschaft aktualisieren möchten, verwenden Sie die folgende PUT-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. groupKey ist die E-Mail-Adresse der Gruppe oder die eindeutige id der Gruppe und memberKey ist die primäre E-Mail-Adresse des Nutzers oder der Gruppe, die Alias-E-Mail-Adresse eines Nutzers oder die eindeutige id des Nutzers. Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz: 

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

JSON-Anfrage

Die folgende JSON-Anfrage zeigt einen Beispielanfragetext, mit dem die Einstellungen für die Gruppenmitgliedschaft aktualisiert werden. Die E-Mail-Adresse des Mitglieds ist liz@example.com und die Rolle des Mitglieds in der Gruppe wird von MEMBER zu MANAGER geändert. Die groupKey der PUT-Anfrage in diesem Beispiel ist NNNNN. Informationen zu den Rollen MEMBER, OWNER und MANAGER finden Sie in der Administratorhilfe: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
 
{
   "email": "liz@example.com",
    "role": "MANAGER"
}

JSON-Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die aktualisierten Mitgliedschaftsinformationen zurückgegeben. Die id ist die eindeutige Mitgliedschafts-ID des Mitglieds: 

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

Mitglied einer Gruppe abrufen

Wenn Sie eine Gruppenmitgliedschaft abrufen möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. groupKey ist die E-Mail-Adresse der Gruppe oder die eindeutige id der Gruppe und memberKey ist die primäre E-Mail-Adresse des Nutzers oder der Gruppe, die Alias-E-Mail-Adresse eines Nutzers oder die eindeutige id des Nutzers. Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz: 

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

JSON-Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Mitgliedschaftsinformationen des Mitglieds zurückgegeben. Die id ist die eindeutige Mitgliedschafts-ID des Mitglieds: 

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

Alle Gruppenmitglieder abrufen

Wenn Sie alle Gruppenmitglieder abrufen möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. groupKey ist die E-Mail-Adresse der Gruppe oder die eindeutige id der Gruppe. Der optionale roles-Suchstring ist ein Filter, mit dem Sie Gruppenmitglieder nach Rolle abrufen können. Die resultierenden Rollensammlungen sind in der Reihenfolge des roles-Filters. Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz. Zur besseren Lesbarkeit enthält dieses Beispiel Zeilenumbrüche: 

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

Alle Mitglieder werden in alphabetischer Reihenfolge der E-Mail-Adressen der Mitglieder zurückgegeben. Verwenden Sie den pageToken-Suchstring für Antworten mit einer großen Anzahl von Mitgliedern. Bei der Paginierung wird in der Antwort das Attribut nextPageToken zurückgegeben, das ein Token für die nächste Seite mit Antwort-Ergebnissen enthält. In Ihrer nächsten Anfrage wird dieses Token als Wert des Abfragestrings pageToken verwendet.

JSON-Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Liste der Mitgliedsinformationen zurückgegeben. Die id ist die eindeutige Mitgliedschafts-ID des Mitglieds. Für die nachfolgende Liste der Gruppenmitglieder in dieser Antwort gibt es ein nextPageToken: 

{
   "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"
}

Mitgliedschaft in einer Gruppe löschen

Wenn Sie die Mitgliedschaft eines Mitglieds in einer Gruppe löschen möchten, verwenden Sie die folgende DELETE-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. groupKey ist die eindeutige id der Gruppe und memberKey die primäre E-Mail-Adresse des gelöschten Nutzers oder Gruppenmitglieds oder die eindeutige id des Nutzers. Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
 Mit der folgenden DELETE-Anfrage wird beispielsweise das Mitglied gelöscht, dessen groupKey „nnn“ ist und dessen memberKey die primäre E-Mail-Adresse des Nutzers, erika@beispiel.de, ist: 
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 zurückgegeben.

Wenn ein Mitglied gelöscht wird, gilt Folgendes:

  • Mitglieder, die Sie entfernen, erhalten keine E‑Mails mehr, die an die Gruppe adressiert sind.
  • Das Konto des Mitglieds wird dabei jedoch nicht gelöscht.
  • Auch wenn Sie den Gruppeninhaber entfernen, funktioniert eine Gruppe weiterhin ganz normal. Als Administrator können Sie die Gruppe verwalten oder die Inhaberschaft auf ein anderes Gruppenmitglied übertragen.