Method: orgunits.list

Ruft eine Liste aller Organisationseinheiten für ein Konto ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
customerId

string

Die eindeutige ID des Google Workspace-Kontos des Kunden. Als Kontoadministrator können Sie auch den my_customer-Alias verwenden, um die customerId Ihres Kontos darzustellen. Das customerId wird auch als Teil der Nutzerressource zurückgegeben.

Abfrageparameter

Parameter
orgUnitPath

string

Der vollständige Pfad zur Organisationseinheit oder ihrer eindeutigen ID. Gibt die untergeordneten Elemente der angegebenen Organisationseinheit zurück.

type

enum (Type)

Gibt an, ob alle Unterorganisationen oder nur unmittelbare Kinder zurückgegeben werden sollen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung
{
  "kind": string,
  "etag": string,
  "organizationUnits": [
    {
      object (OrgUnit)
    }
  ]
}
Felder
kind

string

Der Typ der API-Ressource. Für Ressourcen von Organisationseinheiten lautet der Typ admin#directory#orgUnits.

etag

string

ETag der Ressource.

organizationUnits[]

object (OrgUnit)

Eine Liste der Objekte einer Organisationseinheit.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

Typ

Enums
ALL Alle untergeordneten Organisationseinheiten.
CHILDREN Nur untergeordnete Elemente (Standardeinstellung).
ALL_INCLUDING_PARENT Alle untergeordneten Organisationseinheiten und die angegebene Organisationseinheit (Stamm, falls nicht angegeben)