API каталога: управление клиентами

Вы можете использовать API каталога для программного управления своими клиентами. Методы этого API позволяют обновлять контактную информацию в вашем домене G Suite, а также изменять основной домен для вашего экземпляра.

Получить клиента

Чтобы получить существующего клиента, используйте следующий HTTP-запрос GET и включите токен авторизации, описанный в запросах авторизации . customerKey может быть уникальным идентификатором клиента или my_customer , чтобы указать текущего клиента.

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

Успешный ответ возвращает код состояния HTTP 200 . Помимо кода состояния, ответ JSON включает информацию о клиенте:

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

Обновить существующего клиента

Чтобы обновить существующего клиента, используйте следующий HTTP-запрос PUT и включите токен авторизации, описанный в запросах авторизации . customerKey может быть уникальным идентификатором клиента или my_customer , чтобы указать текущего клиента.

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

Успешный ответ возвращает код состояния HTTP 200 . Наряду с кодом состояния ответ JSON включает недавно обновленную информацию о клиенте:

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

Успешный ответ возвращает код состояния HTTP 200 . Помимо кода состояния, ответ JSON включает информацию о клиенте:

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

Изменение основного доменного имени клиента

Примечание. Вам необходимо получить уникальное значение customerId клиента, используя HTTP-запрос, описанный в разделе Получение клиента . Это значение останется неизменным даже после изменения основного доменного имени.

Чтобы изменить основной домен клиента, используйте следующий HTTP-запрос PUT и включите токен авторизации, описанный в запросах авторизации . customerKey должен быть уникальным идентификатором клиента или my_customer .

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

Тело запроса JSON должно включать новое значение customerDomain :

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

Успешный ответ возвращает код состояния HTTP 200 . Помимо кода состояния, ответ JSON включает информацию о клиенте:

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