Directory API: Gruppenmitglieder

Einer Gruppe ein Mitglied hinzufügen

Verwenden Sie die folgende POST-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung hinzu, um einer Gruppe ein Mitglied hinzuzufügen. 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. Zusätzlich gibt die API einen Fehler für Zyklen in Gruppenmitgliedschaften zurück. Wenn z. B. „gruppe1“ Mitglied von „gruppe2“ ist, kann „gruppe2“ kein Mitglied von „gruppe1“ sein.

JSON-Anfrage

Die folgende JSON-Anfrage zeigt einen Beispiel-Anfragetext zum Erstellen eines Gruppenmitglieds. 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"
}

Die role eines Gruppenmitglieds kann Folgendes sein:

  • OWNER: Nutzer mit dieser Rolle können Nachrichten an die Gruppe senden, Mitglieder hinzufügen oder entfernen, Mitgliederrollen ä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 wird. Mit der Rolle MANAGER können alle Aktionen einer INHABER-Rolle ausgeführt werden, mit Ausnahme, dass ein Mitglied zum Inhaber wird oder die Gruppe gelöscht wird. Eine Gruppe kann mehrere Mitglieder des Typs OWNER und MANAGER haben.
  • MEMBER: Diese Rolle kann eine Gruppe abonnieren, Diskussionsarchiven anzeigen und die Mitgliederliste der Gruppe anzeigen. Weitere Informationen zu Mitgliederrollen finden Sie in der Hilfe für Administratoren.

JSON-Antwort

Bei einer erfolgreichen Antwort werden ein HTTP 200-Statuscode und die Mitgliedschaftsinformationen des Mitglieds zurückgegeben. 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

Verwenden Sie die folgende PUT-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung hinzu, um eine Gruppenmitgliedschaft zu aktualisieren. 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. 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 Beispiel-Anfragetext zum Aktualisieren der Einstellungen einer Gruppenmitgliedschaft. Die E-Mail-Adresse des Mitglieds lautet liz@beispiel.de und die Rolle des Mitglieds in der Gruppe wird von MEMBER zu MANAGER geändert. Der groupKey der PUT-Anfrage ist in diesem Beispiel 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 ein HTTP 200-Statuscode und die aktualisierten Mitgliedschaftsinformationen zurückgegeben. 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

Verwenden Sie zum Abrufen einer Gruppenmitgliedschaft 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. 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 werden ein HTTP 200-Statuscode und die Mitgliedschaftsinformationen des Mitglieds zurückgegeben. 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

Verwenden Sie die folgende GET-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung hinzu, um alle Gruppenmitglieder abzurufen. Die groupKey ist die E-Mail-Adresse der Gruppe oder der eindeutige id der Gruppe. Der optionale roles-Abfragestring ist ein Filter, mit dem Sie Gruppenmitglieder nach Rolle abrufen können. Die resultierenden Rollensammlungen sind in der im roles-Filter angegebenen Reihenfolge angeordnet. Informationen zu den Anfrage- und Antwortattributen finden Sie in der API-Referenz. Zur besseren Lesbarkeit werden in diesem Beispiel Zeilenumsätze verwendet: 

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

JSON-Antwort

Bei einer erfolgreichen Antwort werden ein HTTP 200-Statuscode und die Liste der Mitgliedsinformationen zurückgegeben. id ist die eindeutige Mitgliedschafts-ID des Mitglieds. Es gibt eine nextPageToken für die Folgeliste der Gruppenmitglieder in dieser Antwort: 

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

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 ist 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 Anfrage DELETE wird beispielsweise das Mitglied gelöscht, dessen groupKey „nnn“ und sein 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, 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 Gruppeneigentümer löschen, funktioniert die Gruppe weiterhin normal. Als Administrator können Sie die Gruppe verwalten oder die Inhaberschaft auf ein anderes Gruppenmitglied übertragen