Gruppenverwaltung

Gruppe erstellen

Wenn Sie eine Gruppe erstellen möchten, verwenden Sie die folgende POST-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. Sie können eine Gruppe für jede Domain erstellen, die mit dem Konto verknüpft ist. Informationen zu den Suchstrings, Anfrage- und Antworteigenschaften finden Sie unter groups.insert-Methode.

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

Die folgende JSON-Anfrage zeigt einen Beispiel-Anfragetext, mit dem eine Gruppe erstellt wird. Die E-Mail-Adresse der Gruppe lautet vertrieb_gruppe@beispiel.de:

{
   "email": "sales_group@example.com",
   "name": "Sales Group",
   "description": "This is the Sales group."
}

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201 und die Eigenschaften der neuen Gruppe zurückgegeben.

Gruppe aktualisieren

Wenn Sie die Einstellungen einer Gruppe aktualisieren möchten, verwenden Sie die folgende PUT-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. Die groupKey ist die E-Mail-Adresse der Gruppe, eine der E-Mail-Adressen des Gruppenalias oder die eindeutige groupKey der Gruppe.id Informationen zu den Suchstrings, Anfrage- und Antworteigenschaften finden Sie unter groups.update-Methode.

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

Im Allgemeinen empfiehlt Google, die E-Mail-Adresse der Gruppe nicht als Schlüssel für persistente Daten zu verwenden, da sich die E-Mail-Adresse ändern kann.

Im folgenden Beispiel lautet die eindeutige groupKey nnn und der Name der Gruppe ist APAC Sales Group:

PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn

{
    "email": "sales_group@example.com",
    "name": "APAC Sales Group"
}

Für eine Aktualisierungsanfrage müssen Sie nur die aktualisierten Informationen in Ihrer Anfrage einreichen. Sie müssen nicht alle Properties der Gruppe in die Anfrage eingeben.

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201 und die Eigenschaften der neuen Gruppe zurückgegeben:

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

Gruppenalias hinzufügen

Wenn Sie einen Gruppenalias hinzufügen möchten, verwenden Sie die folgende POST-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. groupKey ist die E-Mail-Adresse der Gruppe, eine der E-Mail-Adressen des Gruppenalias oder die eindeutige groupKey der Gruppe.id Informationen zu Abfragestrings, Anfrage- und Antworteigenschaften finden Sie in der groups-Ressource.

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

Im Allgemeinen empfiehlt Google, die E-Mail-Adresse der Gruppe nicht als Schlüssel für persistente Daten zu verwenden, da sich die E-Mail-Adresse ändern kann.

Die folgende JSON-Anfrage ist ein Beispiel für eine Anfrage zum Erstellen des Alias einer Gruppe. groupKey ist die eindeutige id der Gruppe, die durch NNNN dargestellt wird.

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases

{
    "alias": "best_sales_group@example.com"
}

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201 und die Eigenschaften für den neuen Gruppenalias zurückgegeben.

Gruppe abrufen

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

Im Allgemeinen empfiehlt Google, die E-Mail-Adresse der Gruppe nicht als Schlüssel für persistente Daten zu verwenden, da sich die E-Mail-Adresse ändern kann.

Im folgenden Beispiel lautet die eindeutige groupKey-ID nnnn:

GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Einstellungen der Gruppe zurückgegeben:

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "liz@test.com"
     }
    ]
}

Alle Gruppen für eine Domain oder das Konto abrufen

Wenn Sie alle Gruppen für eine bestimmte Domain oder das Konto abrufen möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Informationen zu Abfragestrings, Anfrage- und Antworteigenschaften finden Sie unter groups.list-Methode. Zur besseren Lesbarkeit enthält dieses Beispiel Zeilenumbrüche:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name
&customer=my_customer or customerId&pageToken=pagination token
&maxResults=max results

Beachten Sie beim Abrufen aller Gruppen für eine Domain oder das Konto Folgendes:

• Alle Gruppen für eine Subdomain: Verwenden Sie das Argument domain mit dem Namen der Domain.
• Alle Gruppen für das Konto: Verwenden Sie das Argument customer mit my_customer oder dem customerId-Wert des Kontos. Als Kontoadministrator können Sie den String my_customer verwenden, um die customerId Ihres Kontos anzugeben. Wenn Sie als Reseller auf das Konto eines Kunden zugreifen, der von Ihnen Produkte gekauft hat, verwenden Sie die customerId des Kontos des Kunden. Verwenden Sie für den Wert customerId den primären Domainnamen des Kontos in der Anfrage für den Vorgang Alle Nutzer in einer Domain abrufen. Die resultierende Antwort enthält den Wert customerId.
• Sowohl domain- als auch customer-Argumente verwenden: Die Directory API gibt alle Gruppen für die domain zurück.
• Die Argumente domain und customer werden nicht verwendet: Die Directory API gibt alle Gruppen für das Konto zurück, das mit my_customer verknüpft ist. Dies ist das Konto customerId des Administrators, der die Anfrage stellt.
• Sowohl das Argument customer als auch das Argument userKey verwenden: Die Directory API gibt einen Fehler zurück. Sie müssen zwei separate Anfragen mit diesen Argumenten senden.

Im folgenden Beispiel fordert ein Kontoadministrator mit my_customer eine Liste aller Gruppen eines Kontos an:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2

Im folgenden Beispiel werden durch die Anfrage eines Reseller-Administrators alle Gruppen für das Reseller-Konto mit der customerId C03az79cb zurückgegeben. Pro Antwortseite werden maximal zwei Ergebnisse zurückgegeben. In dieser Antwort gibt es eine nextPageToken für die nachfolgende Liste der Nutzer:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Gruppen in alphabetischer Reihenfolge der Gruppen-E-Mail-Adresse zurückgegeben:

{
"kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support@sales.com",
      "name": "Sales support",
      "directMembersCount": "6",
      "description": "The sales support group",
      "adminCreated": true
     },
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "travel@sales.com",
      "name": "Sales travel",
      "directMembersCount": "2",
      "description": "The travel group supporting sales",
      "adminCreated": false,
      "aliases": [
       {
         "alias": "best_sales_group@example.com"
       }
      ],
      "nonEditableAliases: [
       {
         "alias": "liz@test.com"
       }
      ]
     },
  "nextPageToken": "NNNN"
  }

Alle Gruppen für ein Mitglied abrufen

Wenn du alle Gruppen abrufen möchtest, für die ein Mitglied ein Abo hat, verwende die folgende GET-Anfrage und füge die unter Anfragen autorisieren beschriebene Autorisierung ein. Zur besseren Lesbarkeit enthält dieses Beispiel Zeilenumbrüche:

GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key
?pageToken=pagination token
&maxResults=maximum results per response page

• Ein Mitglied kann ein Nutzer oder eine Gruppe sein.
• userKey kann die primäre E-Mail-Adresse des Nutzers, der E-Mail-Alias des Nutzers, die primäre E-Mail-Adresse einer Gruppe, der E-Mail-Alias einer Gruppe oder die eindeutige id des Nutzers sein. Letztere lässt sich mit dem Vorgang „Nutzer abrufen“ ermitteln.
• Der in der userKey angegebene Nutzer oder die angegebene Gruppe muss zu Ihrer Domain gehören.
• Verwenden Sie den Abfragestring pageToken für Antworten mit einer großen Anzahl von Gruppen. 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 Abfragestring pageToken verwendet.
• Sowohl das Argument customer als auch das Argument userKey verwenden: Die Directory API gibt einen Fehler zurück. Sie müssen zwei separate Anfragen mit diesen Argumenten senden.

Informationen zu den Anfrage- und Antworteigenschaften finden Sie unter groups.list-Methode.

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 und die Liste der Mitgliedsinformationen zurückgegeben:

• Es werden alle Gruppen zurückgegeben, für die ein Mitglied ein Abo hat, einschließlich Gruppen außerhalb der Domain des Nutzers.
• Die Gruppen werden in alphabetischer Reihenfolge der E-Mail-Adressen der einzelnen Gruppen zurückgegeben.
• Im Antworttext ist id die eindeutige ID der Gruppe.
• In der Antwort enthält die Liste einer Gruppe außerhalb der Domain des Nutzers keine Aliase der externen Gruppe.

{
    "kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "sales_group@example.com",
      "name": "sale group",
      "directMembersCount": "5",
      "description": "Sales group"
     },
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support_group.com",
      "name": "support group",
      "directMembersCount": "5",
      "description": "Support group"
     }
  ],
   "nextPakeToken": "NNNNN"
}

Alle Gruppenaliasse abrufen

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

Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201 und eine Liste der Aliase der Gruppe zurückgegeben.

Gruppenalias löschen

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId

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

Gruppe löschen

Wenn Sie eine Gruppe löschen möchten, verwenden Sie die folgende DELETE-Anfrage und fügen Sie die in Anfragen autorisieren beschriebene Autorisierung ein. Die groupKey ist die eindeutige id der Gruppe:

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey

DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn

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

Wenn eine Gruppe gelöscht wird, passiert Folgendes:

• Alle Mitglieder der Gruppe werden gelöscht. Die Nutzerkonten des Mitglieds werden nicht gelöscht.
• Das Gruppenarchiv wird gelöscht.
• An die Adresse der gelöschten Gruppe gesendete Nachrichten werden nicht zugestellt. Stattdessen erhält der Absender eine Unzustellbarkeitsnachricht.