Method: orgunits.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Pobiera listę wszystkich jednostek organizacyjnych na koncie.
Żądanie HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/orgunits
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
customerId |
string
Unikalny identyfikator konta Google Workspace klienta. Jako administrator konta możesz też użyć aliasu my_customer, aby reprezentować customerId na Twoim koncie. Wartość customerId jest też zwracana w ramach zasobu Users.
|
Parametry zapytania
| Parametry |
orgUnitPath |
string
Pełna ścieżka do jednostki organizacyjnej lub jej unikalny identyfikator. Zwraca podrzędne jednostki organizacyjne określonej jednostki organizacyjnej.
|
type |
enum (Type)
Określa, czy mają zostać zwrócone wszystkie organizacje podrzędne, czy tylko ich podrzędne jednostki.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"kind": string,
"etag": string,
"organizationUnits": [
{
object (OrgUnit)
}
]
} |
| Pola |
kind |
string
Typ zasobu interfejsu API. W przypadku zasobów jednostki organizacyjnej typ to admin#directory#orgUnits.
|
etag |
string
ETag zasobu.
|
organizationUnits[] |
object (OrgUnit)
Lista obiektów jednostek organizacyjnych.
|
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
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
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
Typ
| Wartości w polu enum |
ALL |
Wszystkie podrzędne jednostki organizacyjne. |
CHILDREN |
Tylko bezpośrednie elementy podrzędne (wartość domyślna). |
ALL_INCLUDING_PARENT |
Wszystkie podrzędne jednostki organizacyjne i określona jednostka organizacyjna (jeśli nie jest określona, to jednostka najwyższego poziomu). |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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). |"]]
