API de Directory: Administra clientes

Puedes usar la API de Directory para administrar a tus clientes de manera programática. Los métodos de esta API te permiten actualizar la información de contacto en tu dominio de G Suite, así como cambiar el dominio principal de tu instancia.

Recupera un cliente

Para recuperar un cliente existente, usa la siguiente solicitud HTTP GET e incluye el token de autorización que se describe en cómo autorizar solicitudes. El customerKey puede ser el customerId único o my_customer para indicar el cliente actual.

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

Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta JSON incluye la información del cliente:

{
  "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"
}

Actualizar un cliente existente

Para actualizar un cliente existente, usa la siguiente solicitud HTTP PUT y, además, incluye el token de autorización descrito en Cómo autorizar solicitudes. El customerKey puede ser el customerId único del cliente o my_customer para indicar el cliente actual.

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

Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta JSON incluye la información del cliente recién actualizada:

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

Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta JSON incluye la información del cliente:

{
  "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"
}

Cambia el nombre de dominio principal de un cliente

Nota: Debes recuperar el valor customerId único del cliente mediante la solicitud HTTP que se describe en Recupera un cliente. Este valor se mantendrá coherente, incluso después de cambiar el nombre de dominio principal.

Para cambiar el dominio principal de un cliente, usa la siguiente solicitud HTTP PUT e incluye el token de autorización que se describe en Cómo autorizar solicitudes. customerKey debe ser el ID de cliente único o my_customer.

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

El cuerpo de la solicitud JSON debe incluir el nuevo valor de customerDomain:

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

Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta JSON incluye la información del cliente:

{
  "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"
}