Directory API: Gruppenmitglieder

Einer Gruppe ein Mitglied hinzufügen

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

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 zehn Minuten dauern, bis die Mitglieder der untergeordneten Gruppe als Mitglieder der übergeordneten Gruppe angezeigt werden. Außerdem gibt die API für Zyklen in Gruppenmitgliedschaften einen Fehler zurück. Wenn zum Beispiel Gruppe1 Mitglied von Gruppe2 ist, kann Gruppe2 nicht Mitglied von Gruppe1 sein.

JSON-Anfrage

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

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

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

Bei role eines Gruppenmitglieds kann es sich um Folgendes handeln:

  • OWNER – Diese Rolle kann das Senden von Nachrichten an die Gruppe ändern, Mitglieder hinzufügen oder entfernen, Mitgliederrollen ändern, die Einstellungen der Gruppe ä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 wurde. Eine MANAGER-Rolle hat alle Berechtigungen einer INHABER-Rolle, kann aber kein Mitglied zum INHABER ernennen oder die Gruppe löschen. Eine Gruppe kann mehrere Mitglieder des Typs INHABER und MANAGER haben.
  • MEMBER – Diese Rolle kann eine Gruppe abonnieren, Diskussionsarchive aufrufen und die Mitgliederliste der Gruppe ansehen. Weitere Informationen über Mitgliederrollen finden Sie in der Hilfe für Administratoren.

JSON-Antwort

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

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

Bei type eines Gruppenmitglieds kann es sich um Folgendes handeln:

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

Gruppenmitgliedschaft aktualisieren

Um eine Gruppenmitgliedschaft zu aktualisieren, verwenden Sie die folgende PUT-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Die groupKey ist die E-Mail-Adresse der Gruppe oder die eindeutige id der Gruppe und die 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. In der API-Referenz finden Sie Informationen zu den Anfrage- und Antwortattributen: 

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 lautet liz@beispiel.de und die Rolle des Mitglieds in der Gruppe wird von MEMBER in MANAGER geändert. Der groupKey der PUT-Anfrage in diesem Beispiel ist NNNNN. Informationen zu den Rollen MITGLIED, INHABER und MANAGER finden Sie in der Hilfe für Administratoren: 

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 werden der HTTP 200-Statuscode und die aktualisierten Mitgliedschaftsinformationen zurückgegeben. id ist die eindeutige Mitglieds-ID des Mitglieds: 

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

Mitglied einer Gruppe abrufen

Um eine Gruppenmitgliedschaft abzurufen, verwenden Sie die folgende GET-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Die groupKey ist die E-Mail-Adresse der Gruppe oder die eindeutige id der Gruppe und die 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. In der API-Referenz finden Sie Informationen zu den Anfrage- und Antwortattributen: 

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

JSON-Antwort

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

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

Alle Gruppenmitglieder abrufen

Um alle Gruppenmitglieder abzurufen, verwenden Sie die folgende GET-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Die groupKey ist die E-Mail-Adresse der Gruppe oder die eindeutige id der Gruppe. Der optionale Abfragestring roles ist ein Filter, mit dem Sie Gruppenmitglieder nach Rolle abrufen können. Die resultierenden Rollensammlungen haben die im Filter roles angegebene Reihenfolge. Die Anfrage- und Antwortattribute finden Sie in der API-Referenz. Zur besseren Lesbarkeit werden in diesem Beispiel Zeilen zurückgegeben: 

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 der alphabetischen Reihenfolge der E-Mail-Adressen. Verwenden Sie den Abfragestring pageToken für Antworten mit einer großen Anzahl von Mitgliedern. Im Fall einer Paginierung gibt die Antwort das Attribut nextPageToken zurück, das ein Token für die nächste Seite der Antwortergebnisse enthält. In der nächsten Anfrage wird dieses Token als Wert für den Abfragestring pageToken verwendet.

JSON-Antwort

Bei einer erfolgreichen Antwort werden der HTTP 200-Statuscode und die Liste der Mitgliederinformationen zurückgegeben. id ist die eindeutige Mitglieds-ID des Mitglieds. In dieser Antwort gibt es einen nextPageToken für die Folgeliste der Gruppenmitglieder: 

{
   "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 unter Anfragen autorisieren beschriebene Autorisierung ein. Die 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“ und memberKey die primäre E-Mail-Adresse des Nutzers ist (liz@beispiel.de): 
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com

Bei einer erfolgreichen Antwort wird der Statuscode HTTP 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.
  • Durch das Entfernen eines Mitglieds aus einer Gruppe wird das Konto des Nutzers nicht gelöscht.
  • Wenn Sie den Gruppeninhaber löschen, funktioniert die Gruppe weiterhin normal. Als Administrator können Sie die Gruppe verwalten oder die Eigentümerschaft auf ein anderes Gruppenmitglied übertragen