Method: orgunits.list

Recupera uma lista de todas as unidades organizacionais de uma conta.

Solicitação HTTP

GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/orgunits

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customerId

string

O ID exclusivo da conta do Google Workspace do cliente. Como administrador da conta, você também pode usar o alias my_customer para representar o customerId da conta. O customerId também é retornado como parte do recurso Usuários.

Parâmetros de consulta

Parâmetros
orgUnitPath

string

O caminho completo da unidade organizacional ou o ID exclusivo dela. Retorna os filhos da unidade organizacional especificada.
type

enum (Type)

Define se todas as suborganizações ou apenas os filhos imediatos serão retornados.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "kind": string,
  "etag": string,
  "organizationUnits": [
    {
      object (OrgUnit)
    }
  ]
}
Campos
kind

string

O tipo do recurso da API. Para recursos de unidade organizacional, o tipo é admin#directory#orgUnits.
etag

string

ETag do recurso.
organizationUnits[]

object (OrgUnit)

Uma lista de objetos de unidade organizacional.

Escopos de autorização

Requer um dos seguintes escopos do 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 mais informações, consulte o Guia de autorização.

Tipo

Enums
ALL Todas as subunidades organizacionais.
CHILDREN Somente filhos imediatos (padrão).
ALL_INCLUDING_PARENT Todas as subunidades organizacionais e a unidade organizacional especificada (raiz, se não for especificada).