Method: orgunits.list
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mengambil daftar semua unit organisasi untuk akun.
Permintaan HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/orgunits
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
customerId |
string
ID unik untuk akun Google Workspace pelanggan. Sebagai administrator akun, Anda juga dapat menggunakan alias my_customer untuk mewakili customerId akun Anda. customerId juga ditampilkan sebagai bagian dari resource Pengguna.
|
Parameter kueri
| Parameter |
orgUnitPath |
string
Jalur lengkap ke unit organisasi atau ID uniknya. Menampilkan turunan dari unit organisasi yang ditentukan.
|
type |
enum (Type)
Apakah akan menampilkan semua sub-organisasi atau hanya turunan langsung.
|
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
| Representasi JSON |
{
"kind": string,
"etag": string,
"organizationUnits": [
{
object (OrgUnit)
}
]
} |
| Kolom |
kind |
string
Jenis resource API. Untuk resource Unit Organisasi, jenisnya adalah admin#directory#orgUnits.
|
etag |
string
ETag resource.
|
organizationUnits[] |
object (OrgUnit)
Daftar objek unit organisasi.
|
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
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
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
Jenis
| Enum |
ALL |
Semua unit suborganisasi. |
CHILDREN |
Hanya turunan langsung (default). |
ALL_INCLUDING_PARENT |
Semua unit sub-organisasi dan unit organisasi yang ditentukan (root jika tidak ditentukan). |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-25 UTC.
[null,null,["Terakhir diperbarui pada 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). |"]]
