Method: orgunits.list

Récupère la liste de toutes les unités organisationnelles d'un compte.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Identifiant unique du compte Google Workspace du client. En tant qu'administrateur de compte, vous pouvez également utiliser l'alias my_customer pour représenter customerId de votre compte. Le customerId est également renvoyé dans le cadre de la ressource Users.

Paramètres de requête

Paramètres
orgUnitPath

string

Chemin d'accès complet à l'unité organisationnelle ou à son ID unique. Renvoie les enfants de l'unité organisationnelle spécifiée.
type

enum (Type)

Indique s'il faut renvoyer toutes les sous-organisations ou uniquement les enfants immédiats.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :

Représentation JSON 
{
  "kind": string,
  "etag": string,
  "organizationUnits": [
    {
      object (OrgUnit)
    }
  ]
}
Champs
kind

string

Type de ressource d'API. Pour les ressources d'unité organisationnelle, le type est admin#directory#orgUnits.
etag

string

ETag de la ressource.
organizationUnits[]

object (OrgUnit)

Liste des objets de l'unité organisationnelle.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • 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

Pour en savoir plus, consultez le Guide relatif aux autorisations.

Type

Enums
ALL Toutes les sous-unités organisationnelles.
CHILDREN Enfants immédiats uniquement (par défaut)
ALL_INCLUDING_PARENT Toutes les sous-unités organisationnelles et l'unité organisationnelle spécifiée (racine si non spécifiée).