API Directory: gérer les clients

Vous pouvez utiliser l'API Directory pour gérer vos clients de manière programmatique. Les méthodes de cette API vous permettent de mettre à jour les coordonnées de votre domaine Google Workspace et de modifier le domaine principal de votre instance.

Récupérer un client

Pour récupérer un client existant, utilisez la requête HTTP GET suivante et incluez le jeton d'autorisation décrit dans Autoriser les requêtes. customerKey peut être le customerId unique ou my_customer pour indiquer le client actuel.

GET https://admin.googleapis.com/admin/directory/v1/customers/customerKey

Une réponse réussie renvoie un code d'état HTTP 200. Outre le code d'état, la réponse JSON inclut les informations relatives au client :

{
  "etag": "\"spqlTgq5LGeoin0BH1d0f4rpI98/LnbnRK_ZWu_omowg36CZgTKECrY\"",
  "kind": "admin#directory#customer",
  "alternateEmail": "yuri@example.com",
  "id": "C03xgje4y",
  "customerDomain": "example.com",
  "postalAddress": {
    "organizationName": "Example.com",
    "countryCode": "US"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}

Modifier un client existant

Pour mettre à jour un client existant, utilisez la requête PUT suivante et incluez le jeton d'autorisation décrit dans Autoriser les requêtes. Le customerKey peut être le customerId unique du client ou my_customer pour indiquer le client actuel.

PUT https://admin.googleapis.com/admin/directory/v1/customers/customerKey

Une réponse réussie renvoie un code d'état HTTP 200. En plus du code d'état, la réponse JSON inclut les informations client nouvellement mises à jour :

{
  "etag": "\"spqlTgq5LGeoin0BH1d0f4rpI98/LnbnRK_ZWu_omowg36CZgTKECrY\"",
  "kind": "admin#directory#customer",
  "alternateEmail": "yuri@example.com",
  "id": "C03xgje4y",
  "customerDomain": "example.com",
  "postalAddress": {
    "organizationName": "Example.com",
    "phoneNumber": "+15558675309"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}

Modifier le nom de domaine principal d'un client

Pour modifier le domaine principal d'un client, utilisez la requête PUT suivante et incluez le jeton d'autorisation décrit dans Autoriser les requêtes. Le customerKey doit être le customerId ou le my_customer unique.

PUT https://admin.googleapis.com/admin/directory/v1/customers/customerKey

Le corps de la requête JSON doit inclure la nouvelle valeur customerDomain :

{
  "alternateEmail": "yuri@example.com",
  "customerDomain": "example.com",
  "language": "EN",
  "postalAddress": {
    "organizationName": "Example.com",
    "phoneNumber": "+15558675309"
  }
}