API de Directory: Administra clientes

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

Cómo recuperar un cliente

Para recuperar un cliente existente, usa la siguiente solicitud HTTP GET e incluye el token de autorización que se describe en solicitudes de autorización. 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": "marty.mcfly@gmail.com",
  "id": "C03xgje4y",
  "customerDomain": "amatchmadeinspace.com",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "countryCode": "US"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}

Actualiza un cliente existente

Para actualizar un cliente existente, usa la siguiente solicitud HTTP PUT y, luego, incluye el token de autorización que se describe en solicitudes de autorización. 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 actualizada recientemente:

{
  "alternateEmail": "marty.mcfly@gmail.com",
  "customerDomain": "amatchmadeinspace.com",
  "language": "EN",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "+15558675309"
  }
}

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": "marty.mcfly@gmail.com",
  "id": "C03xgje4y",
  "customerDomain": "amatchmadeinspace.com",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "+15558675309"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}

Cómo cambiar el nombre de dominio principal de un cliente

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 solicitudes de autorización. El customerKey debe ser el customerId ú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": "marty.mcfly@gmail.com",
  "customerDomain": "fluxcapacitor.com",
  "language": "EN",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "+15558675309"
  }
}

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": "marty.mcfly@gmail.com",
  "id": "C03xgje4y",
  "customerDomain": "fluxcapacitor.com",
  "postalAddress": {
    "organizationName": "A Match Made in Space, LLC",
    "phoneNumber": "+15558675309"
  },
  "customerCreationTime": "2015-10-21T20:42:35.224Z"
}