API Directory: gerenciar clientes

É possível usar a API Directory para gerenciar seus clientes de maneira programática. Os métodos dessa API permitem atualizar as informações de contato no seu domínio do G Suite e mudar o domínio principal da sua instância.

Recuperar um cliente

Para recuperar um cliente, use a seguinte solicitação HTTP GET e inclua o token de autorização descrito em Solicitações de autorização. O customerKey pode ser o ID do cliente exclusivo ou my_customer para indicar o cliente atual.

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

Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta JSON inclui as informações do 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"
}

Atualizar um cliente

Para atualizar um cliente, use a seguinte solicitação HTTP PUT e inclua o token de autorização descrito em autorizar solicitações. O customerKey pode ser o ID exclusivo do cliente ou my_customer para indicar o cliente atual.

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

Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta JSON inclui as informações do cliente atualizadas:

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

Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta JSON inclui as informações do 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"
}

Como mudar o nome de domínio principal de um cliente

Observação: é necessário recuperar o valor exclusivo customerId do cliente usando a solicitação HTTP descrita em Recuperar um cliente. Esse valor vai permanecer consistente, mesmo depois que o nome do domínio principal for alterado.

Para mudar o domínio principal de um cliente, use a seguinte solicitação HTTP PUT e inclua o token de autorização descrito em autorizar solicitações. O customerKey precisa ser o ID do cliente exclusivo ou my_customer.

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

O corpo da solicitação JSON precisa incluir o novo valor customerDomain:

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

Uma resposta bem-sucedida retorna um código de status HTTP 200. Além do código de status, a resposta JSON inclui as informações do 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"
}