Method: orgunits.list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ruft eine Liste aller Organisationseinheiten für ein Konto ab.
HTTP-Anfrage
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/orgunits
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter |
customerId |
string
Die eindeutige ID für das Google Workspace-Konto des Kunden. Als Kontoadministrator können Sie auch den Alias my_customer verwenden, um die customerId Ihres Kontos zu repräsentieren. Die customerId wird auch als Teil der Ressource „Nutzer“ zurückgegeben.
|
Abfrageparameter
Parameter |
orgUnitPath |
string
Der vollständige Pfad zur Organisationseinheit oder ihre eindeutige ID. Gibt die untergeordneten Elemente der angegebenen Organisationseinheit zurück.
|
type |
enum (Type )
Gibt an, ob alle untergeordneten Organisationen oder nur unmittelbare untergeordnete Organisationen zurückgegeben werden sollen.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:
JSON-Darstellung |
{
"kind": string,
"etag": string,
"organizationUnits": [
{
object (OrgUnit )
}
]
} |
Felder |
kind |
string
Der Typ der API-Ressource. Für Ressourcen der Organisationseinheit ist der Typ admin#directory#orgUnits .
|
etag |
string
ETag der Ressource.
|
organizationUnits[] |
object (OrgUnit )
Eine Liste von Organisationseinheitsobjekten.
|
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://apps-apis.google.com/a/feeds/policies/
https://www.googleapis.com/auth/admin.directory.orgunit
https://www.googleapis.com/auth/admin.directory.orgunit.readonly
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Typ
Enums |
ALL |
Alle untergeordneten Organisationseinheiten. |
CHILDREN |
Nur unmittelbare untergeordnete Elemente (Standard). |
ALL_INCLUDING_PARENT |
Alle untergeordneten Organisationseinheiten und die angegebene Organisationseinheit (Stammorganisationseinheit, falls nicht angegeben). |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[],[],null,["# Method: orgunits.list\n\nRetrieves a list of all organizational units for an account.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/orgunits`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerId` | `string` The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). |\n\n### Query parameters\n\n| Parameters ||\n|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `orgUnitPath` | `string` The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit. |\n| `type` | `enum (`[Type](/workspace/admin/directory/reference/rest/v1/orgunits/list#Type)`)` Whether to return all sub-organizations or just immediate children. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"organizationUnits\": [ { object (/workspace/admin/directory/reference/rest/v1/orgunits#OrgUnit) } ] } ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the API resource. For Org Unit resources, the type is `admin#directory#orgUnits`. |\n| `etag` | `string` ETag of the resource. |\n| `organizationUnits[]` | `object (`[OrgUnit](/workspace/admin/directory/reference/rest/v1/orgunits#OrgUnit)`)` A list of organizational unit objects. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/policies/`\n- `\n https://www.googleapis.com/auth/admin.directory.orgunit`\n- `\n https://www.googleapis.com/auth/admin.directory.orgunit.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nType\n----\n\n| Enums ||\n|------------------------|---------------------------------------------------------------------------------------------|\n| `ALL` | All sub-organizational units. |\n| `CHILDREN` | Immediate children only (default). |\n| `ALL_INCLUDING_PARENT` | All sub-organizational units and the specified organizational unit (root if not specified). |"]]