Directory API: Organisationseinheiten

Organisationseinheiten verwalten

Die Organisationsstruktur eines Google Workspace-Kontos besteht aus Organisationseinheiten, mit denen Sie Ihre Nutzer in einer logischen und hierarchischen Struktur verwalten können. Diese Funktion ähnelt der Funktion in der Admin-Konsole unter „Organisationen und Nutzer“. . Die Hierarchie der Organisationseinheiten des Kunden ist auf 35 Tiefenebenen beschränkt. Weitere Informationen finden Sie in der Admin-Hilfe.

  • Ein Google Workspace-Konto hat nur eine Organisationsstruktur. Bei der ersten Konfiguration dieses Kontos hat es eine Organisationseinheit auf Kontoebene. Dies ist die Organisation, die mit der primären Domain verknüpft ist. Weitere Informationen zur primären Domain finden Sie unter Informationen zu API-Limits.
  • Der Pfadname einer Organisationseinheit ist eindeutig. Der Name der Organisationseinheit ist innerhalb der Organisationshierarchie möglicherweise nicht eindeutig, aber für alle gleichgeordneten Organisationseinheiten ist er eindeutig. Beim Namen einer Organisationseinheit wird die Groß-/Kleinschreibung nicht berücksichtigt.
  • Eine Organisationseinheit übernimmt die Richtlinien aus der Organisationshierarchie. Beliebige Organisation unit kann diese Kette der elterlichen Vererbung blockieren, indem es die übernommene Richtlinie überschreibt. Die Der Vorrang zwischen einer Richtlinie und einer anderen wird von der nächstgelegenen Organisationseinheit bestimmt. Daher können die Richtlinien einer niedrigeren Organisationseinheit Vorrang vor den Richtlinien der übergeordneten Einheiten. Mit der Einstellung blockInheritance können Sie festlegen, dass Blockierungen von einer Organisationseinheit und ihrer Unterorganisation. blockInheritance wurde verworfen. Das Festlegen auf „true“ wird nicht mehr unterstützt und kann unbeabsichtigte Folgen haben. Für Weitere Informationen zur Übernahme und zu Nutzern in einer Organisationsstruktur finden Sie in der Verwaltungshilfe.
  • Eine Organisationseinheit kann in einer hierarchischen Struktur nach oben oder unten verschoben werden. Die mit der Organisation verknüpften Nutzer können einzeln oder per Bulk-Verfahren verschoben werden, wenn Sie eine neue Organisation hinzufügen oder eine Untergruppe von Nutzern von einer Organisationseinheit in eine andere verschieben.
  • Die Daten in den Eigenschaften der Organisationseinheit können sich ständig ändern. Wenn Sie eine Anfrage stellen, sind die für eine Entität zurückgegebenen Eigenschaften zum Zeitpunkt des Abrufens der Entität garantiert konsistent.Das heißt, Sie sehen nicht den Status "Teilweise" Aktualisierungen. Wenn bei einem Abrufvorgang mehr als eine Entität zurückgegeben wird, gibt es keine Konsistenzgarantie zwischen den Entitäten.Dies gilt insbesondere, wenn sich eine Antwort über mehrere Seiten in Paginierung erstreckt.

Organisationseinheit erstellen

Um eine Organisationseinheit zu erstellen, verwenden Sie die folgende POST-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein.

Wenn Sie ein Administrator sind und eine Organisationseinheit erstellen, verwenden Sie my_customer.

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits

Wenn Sie als Reseller eine Organisationseinheit für einen Kunden erstellen, verwenden Sie customerId. Verwenden Sie zum Abrufen des customerId den Vorgang Nutzer abrufen.

POST https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits

Informationen zur Organisationsstruktur Ihres Kontos finden Sie in der Admin-Hilfe. Informationen zu Anfrage- und Antwortattributen finden Sie in der API-Referenz.

JSON-Anfrage

Das folgende JSON-Reseller-Beispiel zeigt einen Beispielanfragetext, mit dem die Organisationseinheit „sales_support“ erstellt wird. name und parentOrgUnitPath sind erforderlich:

POST https://admin.googleapis.com/admin/directory/v1/customer/C03az79cb/orgunits
{
    "name": "sales_support",
    "description": "The sales support team",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
}

JSON-Antwort

Bei einer erfolgreichen Antwort wird der Statuscode HTTP 201 zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Eigenschaften für die neue Gruppe zurückgegeben:

{
    "kind": "directory#orgUnit",
    "name": "sales_support",
    "description": "The sales support team",
    "orgUnitPath": "/corp/support/sales_support",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
  }

Organisationseinheit aktualisieren

Um eine Organisationseinheit zu aktualisieren, verwenden Sie die folgende PUT-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. In der API-Referenz finden Sie Informationen zu den Anfrage- und Antwortattributen:

Wenn Sie ein Administrator sind und eine Organisationseinheit aktualisieren, verwenden Sie my_customer.

 PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/orgUnitPath

Wenn Sie als Reseller eine Organisationseinheit für einen Kunden eines Resellers aktualisieren, verwenden Sie customerId. Verwenden Sie zum Abrufen des customerId den Vorgang Nutzer abrufen.

PUT https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath

JSON-Anfrage

Im folgenden Beispiel wurde die Beschreibung der Organisationseinheit aktualisiert:

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/corp/support/sales_support
{
    "description": "The BEST sales support team"
}

Hinweise zu einer Aktualisierungsanfrage:

  • Sie müssen lediglich die aktualisierten Informationen in Ihrem Antrag einreichen. Sie müssen nicht alle Eigenschaften der Gruppe in der Anfrage eingeben.
  • Wenn ein Nutzer bei der Erstellung des Nutzerkontos keiner bestimmten Organisationseinheit zugewiesen wurde, befindet sich das Konto in der obersten Organisationseinheit.
  • Sie können eine Organisationseinheit in einen anderen Teil der Organisationsstruktur Ihres Kontos verschieben, indem Sie in der Anfrage das Attribut parentOrgUnitPath festlegen. Beachten Sie, dass sich durch das Verschieben einer Organisationseinheit auch die Dienste und Einstellungen für die Nutzer in der zu verschiebenden Organisationseinheit ändern.

JSON-Antwort

Bei einer erfolgreichen Antwort wird der Statuscode HTTP 201 zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Eigenschaften der aktualisierten Organisationseinheit zurückgegeben.

{
    "kind": "directory#orgUnit",
    "name": "sales_support",
    "description": "The BEST sales support team",
    "orgUnitPath": "/corp/support/sales_support",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
}

Wenn ein Nutzer bei der Erstellung des Nutzerkontos keiner bestimmten Organisationseinheit zugewiesen wurde, befindet sich das Konto in der obersten Organisationseinheit. Die Organisationseinheit eines Nutzers bestimmt, auf welche Google Workspace-Dienste der Nutzer Zugriff hat. Wenn der Nutzer in eine neue Organisation verschoben wird, ändert sich sein Zugriff. Weitere Informationen zu Organisationsstrukturen finden Sie in der Hilfe für Administratoren. Weitere Informationen zum Verschieben eines Nutzers in eine andere Organisation finden Sie unter Nutzer aktualisieren.

Organisationseinheit abrufen

Um eine Organisationseinheit abzurufen, verwenden Sie die folgende GET-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Der Abfragestring orgUnitPath ist der vollständige Pfad für diese Organisationseinheit. In der API-Referenz finden Sie Informationen zu den Anfrage- und Antwortattributen:

Wenn Sie ein Administrator sind und eine Organisationseinheit abrufen, verwenden Sie my_customer.

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/orgUnitPath

Wenn Sie als Reseller eine Organisationseinheit für einen Kunden eines Resellers abrufen, verwenden Sie die customerId. Verwenden Sie zum Abrufen des customerId den Vorgang Nutzer abrufen.

GET https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath

JSON-Antwort

Im folgenden Beispiel sind „Frontline-Verkäufe“ Organisationseinheit abgerufen wird. Hinweis: 'Frontline+Vertrieb' HTTP-Codierung im URI der Anfrage:

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/corp/sales/frontline+sales

Bei einer erfolgreichen Antwort wird der Statuscode HTTP 200 zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Einstellungen der Organisationseinheit zurückgegeben:

{
    "kind": "directory#orgUnit",
    "name": "frontline sales",
    "description": "The frontline sales team",
    "orgUnitPath": "/corp/sales/frontline sales",
    "parentOrgUnitPath": "/corp/sales",
    "blockInheritance": false
}

Organisationseinheiten abrufen

Wenn Sie alle untergeordneten Organisationseinheiten, die unmittelbar untergeordneten Organisationseinheiten oder alle untergeordneten Organisationseinheiten sowie alle untergeordneten Organisationseinheiten sowie die angegebene Organisationseinheit abrufen möchten, verwenden Sie die folgende GET-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Die Anfrage- und Antwortattribute finden Sie in der API-Referenz.

Wenn Sie ein Kontoadministrator sind und alle untergeordneten Organisationseinheiten abrufen, verwenden Sie my_customer. Zur besseren Lesbarkeit werden in diesem Beispiel Zeilen zurückgegeben:

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer
/orgunits?orgUnitPath=full org unit path&type=all or children or all_including_parent

Wenn Sie als Reseller Organisationseinheiten für einen Kunden eines Resellers abrufen, verwenden Sie die customerId. Verwenden Sie zum Abrufen des customerId den Vorgang Nutzer abrufen:

GET https://admin.googleapis.com/admin/directory/v1/customer/customerId
/orgunits?orgUnitPath=full org unit path&type=all or children or all_including_parent

Der Abfragestring get gibt entweder all untergeordnete Organisationseinheiten unter orgUnitPath, den unmittelbaren children der orgUnitPath oder alle untergeordneten Organisationseinheiten und die angegebenen orgUnitPath für all_including_parent zurück. Der Standardwert ist type=children.

JSON-Antwort

Bei dieser Anfrage werden z. B. alle Organisationseinheiten ab der Organisationseinheit /corp zurückgegeben:

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits?orgUnitPath=/corp&type=all

Bei einer erfolgreichen Antwort wird der Statuscode HTTP 200 zurückgegeben. Zusammen mit dem Statuscode werden in der Antwort die Organisationseinheiten des Kontos zurückgegeben:

{
"kind": "directory#orgUnits",
    "organizationUnits": [
     {
    "kind": "directory#orgUnit",
    "name": "sales",
    "description": "The corporate sales team",
    "orgUnitPath": "/corp/sales",
    "parentOrgUnitPath": "/corp",
    "blockInheritance": false
     },
     {
    "kind": "directory#orgUnit",
    "name": "frontline sales",
    "description": "The frontline sales team",
    "orgUnitPath": "/corp/sales/frontline sales",
    "parentOrgUnitPath": "/corp/sales",
    "blockInheritance": false
     },
     {
    "kind": "directory#orgUnit",
    "name": "support",
    "description": "The corporate support team",
    "orgUnitPath": "/corp/support",
    "parentOrgUnitPath": "/corp",
    "blockInheritance": false
     },
     {
    "kind": "directory#orgUnit",
    "name": "sales_support",
    "description": "The BEST support team",
    "orgUnitPath": "/corp/support/sales_support",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
     }
  ]
  }

Organisationseinheit löschen

Um eine Organisationseinheit zu löschen, verwenden Sie die folgende DELETE-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Verwenden Sie zum Abrufen des customerId den Vorgang Nutzer abrufen. In der API-Referenz finden Sie Informationen zu den Anfrage- und Antwortattributen:

Wenn Sie ein Kontoadministrator sind und eine Organisationseinheit löschen, verwenden Sie my_customer.

DELETE https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/orgUnitPath

Wenn Sie als Reseller eine Organisationseinheit für einen Kunden löschen, verwenden Sie die customerId. Verwenden Sie zum Abrufen des customerId den Vorgang Nutzer abrufen.

DELETE https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath
Die DELETE-Anfrage dieses Reseller-Administrators löscht beispielsweise "backend_tests". Organisationseinheit:
DELETE https://admin.googleapis.com/admin/directory/v1/customer/C03az79cb/orgunits/corp/sales/backend_tests

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

Sie können nur Organisationseinheiten löschen, denen keine untergeordneten Organisationseinheiten oder Nutzer zugewiesen sind. Sie müssen die Nutzer vor dem Löschen anderen Organisationseinheiten zuweisen und alle untergeordneten Organisationseinheiten entfernen.