Method: orgunits.list

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. customerId también se muestra como parte del Recurso de usuarios.

Parámetros de consulta

Parámetros
orgUnitPath

string

La ruta de acceso completa a la unidad organizativa o su ID único. Muestra los elementos secundarios de la unidad organizativa especificada.
type

enum (Type)

Indica si se deben mostrar todas las suborganizaciones o solo los elementos secundarios inmediatos.

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 unidades organizativas, el tipo es admin#directory#orgUnits.
etag

string

ETag del recurso.
organizationUnits[]

object (OrgUnit)

Una lista de objetos de unidades organizativas.

Alcances 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 subunidades organizativas.
CHILDREN Solo elementos secundarios inmediatos (predeterminado).
ALL_INCLUDING_PARENT Todas las subunidades organizativas y la unidad organizativa especificada (si no se especifica la raíz)