Method: orgunits.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recupera una lista de todas las unidades organizativas de una cuenta.
Solicitud HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/orgunits
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros |
customerId |
string
El ID único de la cuenta de Google Workspace del cliente. Como administrador de la cuenta, también puedes usar el alias my_customer para representar el customerId de tu cuenta. El customerId también se muestra como parte del recurso Usuarios.
|
Parámetros de consulta
Parámetros |
orgUnitPath |
string
Es la ruta de acceso completa a la unidad organizativa o su ID único. Muestra las unidades organizativas secundarias de la unidad organizativa especificada.
|
type |
enum (Type )
Indica si se deben mostrar todas las suborganizaciones o solo las secundarias inmediatas.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Representación JSON |
{
"kind": string,
"etag": string,
"organizationUnits": [
{
object (OrgUnit )
}
]
} |
Campos |
kind |
string
Tipo de recurso de la API. Para los recursos de unidad organizativa, el tipo es admin#directory#orgUnits .
|
etag |
string
ETag del recurso.
|
organizationUnits[] |
object (OrgUnit )
Una lista de objetos de unidad organizativa.
|
Permisos de autorización
Se necesita uno de los siguientes permisos de 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
Para obtener más información, consulta la Guía de autorización.
Tipo
Enumeraciones |
ALL |
Todas las unidades organizativas secundarias |
CHILDREN |
Solo elementos secundarios inmediatos (predeterminado) |
ALL_INCLUDING_PARENT |
Todas las unidades organizativas secundarias y la unidad organizativa especificada (raíz si no se especifica). |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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). |"]]