Interfejs Directory API: zarządzanie klientami

Interfejs Directory API umożliwia automatyczne zarządzanie klientami. Metody używane w tym interfejsie API pozwalają aktualizować informacje kontaktowe w domenie G Suite oraz zmieniać domenę podstawową instancji.

Pobieranie klienta

Aby pobrać istniejącego klienta, użyj poniższego żądania HTTP GET i dołącz token autoryzacji opisany w artykule o autoryzowaniu żądań. customerKey może być unikalnym identyfikatorem klienta lub obiektem my_customer, który wskazuje bieżącego klienta.

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

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź JSON zawiera informacje o kliencie:

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

Aktualizowanie istniejącego klienta

Aby zaktualizować obecnego klienta, użyj poniższego żądania HTTP PUT i dołącz token autoryzacji opisany w artykule o autoryzowaniu żądań. customerKey może być unikalnym identyfikatorem klienta lub my_customer, aby wskazywać bieżącego klienta.

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

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź JSON zawiera nowo zaktualizowane informacje o kliencie:

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

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź JSON zawiera informacje o kliencie:

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

Zmienianie nazwy domeny podstawowej klienta

Aby zmienić domenę podstawową klienta, użyj poniższego żądania HTTP PUT i dołącz token autoryzacji opisany w sekcji Autoryzacja żądań. Wartość customerKey musi być unikalnym identyfikatorem klienta, czyli my_customer.

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

Treść żądania JSON musi zawierać nową wartość customerDomain:

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

Pomyślna odpowiedź zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź JSON zawiera informacje o kliencie:

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