REST Resource: partners.customers

Zasób: firma

Sprzedawca, dostawca lub klient w interfejsach API typu zero-touch i klienty.

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

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

string

Wymagany. Tylko dane wejściowe. Adres e-mail użytkowników klienta przypisanych do roli właściciela. Wymagany jest co najmniej 1 element owner_email. Właściciele mają te same uprawnienia dostępu co administratorzy, ale mogą dodawać, usuwać i edytować użytkowników portalu organizacji.
adminEmails[]

string

Opcjonalnie. Adres e-mail użytkowników klienta pełniącego rolę administratora. Każdy adres e-mail musi być powiązany z kontem Google.
termsStatus

enum (TermsStatus)

Tylko dane wyjściowe. Który 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. Jeśli urządzenie kwalifikuje się do skorzystania z dodatkowej usługi DEVICE_PROTECTION, należy pominąć e-maila powitalnego, ponieważ w momencie odbierania urządzenia klient otrzyma osobne e-maile. Jeśli nie jest to klient typu zero-touch, to pole jest ignorowane.
languageCode

string

Tylko dane wejściowe. Preferowany język klienta reprezentowany przez kod języka BCP47. To pole jest sprawdzane podczas przesyłania. Żądania zawierające nieobsługiwane kody językowe będą odrzucane. Obsługiwane kody języków: angielski (Wielka Brytania) francusko-angielski (niderlandzki)
googleWorkspaceAccount

object (GoogleWorkspaceAccount)

Tylko dane wyjściowe. Konto Google Workspace powiązane z tym klientem. Stosowany tylko dla firm klienta.

Stan Warunków

zaakceptowanie przez firmę Warunków korzystania z usługi rejestracji typu zero-touch, Jeden użytkownik może zaakceptować Warunki swojej firmy za pomocą portalu internetowego.

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

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

Konto GoogleWorkspace

Klient Google Workspace.

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

string

Wymagany. Identyfikator klienta.
preProvisioningTokens[]

string

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

Metody

create

 Utworzy klienta do rejestracji typu zero-touch.

list

 Zawiera listę klientów zarejestrowanych u sprzedawcy określonych za pomocą argumentu partnerId.