REST Resource: partners.customers

Zasób: Company

Sprzedawca, dostawca lub klient w ramach interfejsów API dla sprzedawców i klientów korzystających z rejestracji typu zero-touch.

Zapis JSON 
{
  "name": string,
  "companyId": string,
  "companyName": string,
  "ownerEmails": [
    string
  ],
  "adminEmails": [
    string
  ],
  "termsStatus": enum (TermsStatus),
  "skipWelcomeEmail": boolean,
  "languageCode": string,
  "googleWorkspaceAccount": {
    object (GoogleWorkspaceAccount)
  }
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu interfejsu API firmy. Nazwa zasobu ma jeden z tych formatów:

  • partners/[PARTNER_ID]/customers/[CUSTOMER_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]

Przypisana przez serwer.
companyId

string (int64 format)

Tylko dane wyjściowe. Identyfikator firmy. Przypisana przez serwer.
companyName

string

Wymagane. Nazwa firmy. Przykład: XYZ Corp. Wyświetlane pracownikom firmy w portalu rejestracji typu zero-touch.
ownerEmails[]

string

Wymagane. Tylko dane wejściowe. Adresy e-mail użytkowników klienta z rolą właściciela. Wymagany jest co najmniej 1 owner_email. Właściciele mają takie same uprawnienia jak administratorzy, ale mogą też dodawać, usuwać i edytować użytkowników portalu organizacji.
adminEmails[]

string

Opcjonalnie: Adresy e-mail użytkowników klienta z rolą administratora. Każdy adres e-mail musi być powiązany z kontem Google.
termsStatus

enum (TermsStatus)

Tylko dane wyjściowe. czy dowolny użytkownik z firmy zaakceptował najnowsze Warunki korzystania z usługi. Zobacz TermsStatus.
skipWelcomeEmail

boolean

Tylko dane wejściowe. Jeśli ma wartość Prawda, e-mail powitalny nie jest wysyłany do klienta. Zalecamy pominięcie e-maila powitalnego w przypadku zgłoszenia własności urządzeń w ramach dodatkowej usługi DEVICE_PROTECTION, ponieważ klient otrzyma osobne e-maile w momencie zgłoszenia własności urządzenia. Jeśli to nie jest klient korzystający z rejestracji typu zero-touch, to pole jest ignorowane.
languageCode

string

Tylko dane wejściowe. Preferowany region klienta podany jako kod języka BCP47. To pole jest sprawdzane podczas wprowadzania danych, a żądania zawierające nieobsługiwane kody języka będą odrzucane.

googleWorkspaceAccount

object (GoogleWorkspaceAccount)

Tylko dane wyjściowe. Konto Google Workspace powiązane z tym klientem. Używany tylko w przypadku firm klientów.

TermsStatus

Akceptacja przez firmę Warunków korzystania z usługi rejestracji typu zero-touch. Jeden użytkownik może zaakceptować Warunki korzystania z usługi w swojej firmie w portalu internetowym.

Warunki korzystania z usługi mają różne wersje. Oznacza to, że po zmianie Warunków korzystania z usługi co najmniej 1 użytkownik musi je zaakceptować. Dopóki pierwszy użytkownik nie zaakceptuje nowych Warunków korzystania z usługi, stan warunków firmy będzie wynosić TERMS_STATUS_STALE.

Wartości w polu enum
TERMS_STATUS_NOT_ACCEPTED Żaden z użytkowników firmy nie zaakceptował Warunków korzystania z usługi.
TERMS_STATUS_ACCEPTED Co najmniej jeden z użytkowników firmy zaakceptował Warunki korzystania z usługi.
TERMS_STATUS_STALE Żaden z użytkowników firmy nie zaakceptował obecnych Warunków korzystania z usługi, ale przynajmniej jeden z nich zaakceptował poprzednie.

GoogleWorkspaceAccount

jest klientem Google Workspace;

Zapis JSON 
{
  "customerId": string,
  "preProvisioningTokens": [
    string
  ]
}
Pola
customerId

string

Wymagane. Identyfikator klienta.
preProvisioningTokens[]

string

Tylko dane wyjściowe. Tokeny wstępnej obsługi administracyjnej używane wcześniej do zgłaszania urządzeń.

Metody

create

 Tworzy klienta na potrzeby rejestracji typu zero-touch.

list

 Zawiera listę klientów zarejestrowanych u sprzedawcy określonego przez argument partnerId.