API Directory: Gérer les clients

Vous pouvez utiliser l'API Directory pour gérer vos clients par programmation. Les méthodes de cette API vous permettent de mettre à jour les coordonnées de votre domaine G Suite 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 la section 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

Les appels réussis renvoient un code d'état HTTP 200. Avec le code d'état, la réponse JSON inclut les informations sur le client:

{
  "etag": "\"spqlTgq5LGeoin0BH1d0f4rpI98/LnbnRK_ZWu_omowg36CZgTKECrY\"",
  "kind": "admin#directory#customer",
  "alternateEmail": "[e-mail]",
  "id": "C03xgje4y",
  "customerDomain": "amatchmadeinspace.com",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "countryCode": "US"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}

Mettre à jour un client existant

Pour mettre à jour un client existant, utilisez la requête HTTP PUT suivante et incluez le jeton d'autorisation décrit dans la section Autoriser les requêtes. 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

Les appels réussis renvoient un code d'état HTTP 200. Avec le code d'état, la réponse JSON inclut les informations client récemment mises à jour:

{
  "alternateEmail": "[e-mail]",
  "customerDomain": "amatchmadeinspace.com",
  "language": "EN",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "[phone]"
  }
}

Les appels réussis renvoient un code d'état HTTP 200. Avec le code d'état, la réponse JSON inclut les informations sur le client:

{
  "etag": "\"spqlTgq5LGeoin0BH1d0f4rpI98/LnbnRK_ZWu_omowg36CZgTKECrY\"",
  "kind": "admin#directory#customer",
  "alternateEmail": "[e-mail]",
  "id": "C03xgje4y",
  "customerDomain": "amatchmadeinspace.com",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "[phone]"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}

Modifier le nom de domaine principal d'un client

Remarque :Vous devez récupérer la valeur customerId unique du client à l'aide de la requête HTTP décrite dans la section Récupérer un client. Cette valeur reste cohérente, même après la modification du nom de domaine principal.

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

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

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

{
  "alternateEmail": "[e-mail]",
  "customerDomain": "fluxcapacitor.com",
  "language": "EN",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "[phone]"
  }
}

Les appels réussis renvoient un code d'état HTTP 200. Avec le code d'état, la réponse JSON inclut les informations sur le client:

{
  "etag": "\"spqlTgq5LGeoin0BH1d0f4rpI98/LnbnRK_ZWu_omowg36CZgTKECrY\"",
  "kind": "admin#directory#customer",
  "alternateEmail": "[e-mail]",
  "id": "C03xgje4y",
  "customerDomain": "fluxcapacitor.com",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "[phone]"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}