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

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

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

Для получения информации о существующем клиенте используйте следующий HTTP-запрос GET и укажите токен авторизации, описанный в разделе авторизации запросов . В customerKey можно использовать уникальный идентификатор клиента (customerId) или 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": "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"
}

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

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

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

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

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

В случае успешного ответа возвращается код состояния HTTP 200. Вместе с кодом состояния JSON-ответ содержит информацию о клиенте:

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

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

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

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

В теле JSON-запроса должно содержаться новое значение customerDomain :

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

В случае успешного ответа возвращается код состояния HTTP 200. Вместе с кодом состояния JSON-ответ содержит информацию о клиенте:

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