Method: orgunits.list

アカウントのすべての組織部門のリストを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
customerId

string

お客様の Google Workspace アカウントの一意の ID。アカウント管理者として、my_customer エイリアスを使用してアカウントの customerId を表すこともできます。customerId は、Users リソースの一部としても返されます。

クエリ パラメータ

パラメータ
orgUnitPath

string

組織部門へのフルパスまたは一意の ID です。指定した組織部門の子を返します。

type

enum (Type)

すべての下位組織を返すか、直接の子のみを返すかを指定します。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "kind": string,
  "etag": string,
  "organizationUnits": [
    {
      object (OrgUnit)
    }
  ]
}
フィールド
kind

string

API リソースのタイプ。組織部門リソースの場合、タイプは admin#directory#orgUnits です。

etag

string

リソースの ETag。

organizationUnits[]

object (OrgUnit)

組織部門オブジェクトのリスト。

認可スコープ

次の 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

詳細については、承認ガイドをご覧ください。

種類

列挙型
ALL すべての下位組織部門。
CHILDREN 直接の子のみ(デフォルト)。
ALL_INCLUDING_PARENT すべての下位組織部門と指定した組織部門(指定しない場合はルート)。