Directory API: zarządzanie klientami

Interfejs Directory API umożliwia programowe zarządzanie klientami. Metody w tym interfejsie API umożliwiają aktualizowanie danych kontaktowych w domenie Google Workspace, a także zmianę domeny podstawowej instancji.

Pobieranie informacji o kliencie

Aby pobrać istniejącego klienta, użyj tego żądania HTTP GET i dołącz token autoryzacji opisany w sekcji Autoryzowanie żądań. Wartość customerKey może być unikalnym identyfikatorem klienta lub my_customer, co oznacza bieżącego klienta.

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

Odpowiedź zakończona powodzeniem 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ć istniejącego klienta, użyj tego żądania HTTP PUT i dołącz token autoryzacji opisany w sekcji Autoryzowanie żądań. Wartość customerKey może być unikalnym identyfikatorem klienta (customerId) lub wartością my_customer, która wskazuje bieżącego klienta.

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

Odpowiedź zakończona powodzeniem zwraca kod stanu HTTP 200. Oprócz kodu stanu odpowiedź JSON zawiera zaktualizowane informacje o kliencie:

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

Odpowiedź zakończona powodzeniem 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"
}

Zmiana nazwy domeny podstawowej klienta

Aby zmienić domenę podstawową klienta, użyj tego żądania HTTP PUT i dołącz token autoryzacji opisany w sekcji Autoryzowanie żądań. Wartość customerKey musi być niepowtarzalnym identyfikatorem klienta lub wartością 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"
  }
}

Odpowiedź zakończona powodzeniem 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"
}