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 E-Mail-Adresse der Gruppe des neuen Mitglieds oder die eindeutige id der Gruppe. Informationen zu den Anfrage- und Antworteigenschaften 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 Gruppe 1 Mitglied von Gruppe 2 ist, kann Gruppe 2 kein Mitglied von Gruppe 1 sein.

JSON-Anfrage

Die folgende JSON-Anfrage zeigt einen Beispiel-Anfragetext, mit dem ein Gruppenmitglied erstellt wird. Die E-Mail-Adresse des Mitglieds lautet liz@beispiel.de und seine Rolle in der Gruppe ist MEMBER. In der POST-Anfrage wird NNNNN für die 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: Mit dieser Rolle können Nachrichten an die Gruppe gesendet, Mitglieder hinzugefügt oder entfernt, Mitgliedsrollen geändert, die Einstellungen der Gruppe geändert und die Gruppe gelöscht werden. Ein OWNER muss Mitglied der Gruppe sein.
  • MANAGER: Diese Rolle ist nur verfügbar, wenn Google Workspace über die Admin-Konsole aktiviert ist. Nutzer mit der Rolle „Manager“ können alle Aktionen ausführen, die auch Inhaber ausführen können, mit der Ausnahme, dass sie andere Mitglieder nicht zum Inhaber machen und die Gruppe nicht löschen können. Eine Gruppe kann mehrere Inhaber und Manager haben.
  • MEMBER: Mit dieser Rolle können Gruppen abonniert, Diskussionsarchive aufgerufen und die Mitgliederliste der Gruppe eingesehen werden. Weitere Informationen zu Mitgliedsrollen finden Sie in der Verwaltungshilfe.

JSON-Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Mitgliedschaftsinformationen des Mitglieds zurückgegeben. Die 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"
  }

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. 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 Antworteigenschaften 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 Beispiel-Anfragetext, mit dem die Einstellungen für die Gruppenmitgliedschaft aktualisiert werden. Die E-Mail-Adresse des Mitglieds lautet liz@beispiel.de und seine Rolle in der Gruppe wird von MEMBER in MANAGER geändert. Die groupKey der PUT-Anfrage in diesem Beispiel ist NNNNN. Informationen zu den Rollen „MITGLIED“, „INHABER“ und „MANAGER“ finden Sie in der Verwaltungshilfe: 

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 Mitglieds-ID des Mitglieds: 

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

Gruppenmitglieder 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. 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 Antworteigenschaften 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 Mitglieds-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 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 werden in der im roles-Filter angegebenen Reihenfolge zurückgegeben. Informationen zu den Anfrage- und Antworteigenschaften 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 zurückgegeben. Verwenden Sie den pageToken-Suchstring für Antworten mit einer großen Anzahl von Mitgliedern. Bei der Paginierung gibt die Antwort die Property nextPageToken zurück, die ein Token für die nächste Seite mit Antwortergebnissen enthält. In der nächsten Anfrage wird dieses Token als Wert für den pageToken-Suchstring verwendet.

JSON-Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Liste der Mitgliederinformationen zurückgegeben. Die id ist die eindeutige Mitglieds-ID des Mitglieds. In dieser Antwort gibt es eine nextPageToken für die nachfolgende Liste 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 in Anfragen autorisieren beschriebene Autorisierung ein. groupKey ist die eindeutige id der Gruppe und memberKey ist die primäre E-Mail-Adresse des gelöschten Nutzers oder Gruppenmitglieds oder die eindeutige id des Nutzers. Informationen zu den Anfrage- und Antworteigenschaften finden Sie in der API-Referenz: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
 Mit dieser DELETE-Anfrage wird beispielsweise das Mitglied gelöscht, dessen groupKey „nnn“ und dessen memberKey die primäre E-Mail-Adresse des Nutzers, „liz@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, hat das folgende Auswirkungen:

  • 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 löschen, funktioniert eine Gruppe weiterhin. Als Administrator können Sie die Gruppe verwalten oder die Inhaberschaft auf ein anderes Gruppenmitglied übertragen.