REST Resource: partners.customers

Ресурс: Компания

Торговый посредник, поставщик или клиент в автоматических API торгового посредника и клиента.

Представление JSON
{
  "name": string,
  "companyId": string,
  "companyName": string,
  "ownerEmails": [
    string
  ],
  "adminEmails": [
    string
  ],
  "termsStatus": enum (TermsStatus),
  "skipWelcomeEmail": boolean,
  "languageCode": string,
  "googleWorkspaceAccount": {
    object (GoogleWorkspaceAccount)
  }
}
Поля
name

string

Только вывод. Название ресурса API компании. Имя ресурса имеет один из следующих форматов:

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

Назначается сервером.

companyId

string ( int64 format)

Только вывод. Идентификатор компании. Назначается сервером.

companyName

string

Необходимый. Название компании. Например , компания XYZ . Отображается для сотрудников компании на портале автоматической регистрации.

ownerEmails[]

string

Необходимый. Только ввод. Адрес электронной почты пользователей клиента в роли владельца. Требуется хотя бы один owner_email . Владельцы имеют тот же доступ, что и администраторы, но также могут добавлять, удалять и редактировать пользователей портала вашей организации.

adminEmails[]

string

Необязательный. Адрес электронной почты пользователей клиента в роли администратора. Каждый адрес электронной почты должен быть связан с учетной записью Google.

termsStatus

enum ( TermsStatus )

Только вывод. Принял ли какой-либо пользователь из компании последние Условия использования (ToS). См. TermsStatus .

skipWelcomeEmail

boolean

Только ввод. Если установлено значение true, приветственное письмо клиенту не будет отправлено. Рекомендуется пропустить приветственное письмо, если устройства будут востребованы с помощью дополнительной службы DEVICE_PROTECTION, так как клиент получит отдельные электронные письма во время подачи заявки на устройство. Это поле игнорируется, если это не клиент Zero-touch.

languageCode

string

Только ввод. Предпочтительная локаль клиента, представленная в виде языкового кода BCP47. Это поле проверяется при вводе, и запросы, содержащие коды неподдерживаемых языков, будут отклонены. Поддерживаемые языковые коды: Арабский (ar) Китайский (Гонконг) (zh-HK) Китайский (упрощенный) (zh-CN) Китайский (традиционный) (zh-TW) Чешский (cs) Датский (da) Голландский (nl) Английский ( UK) (en-GB) английский (US) (en-US) филиппинский (fil) финский (fi) французский (fr) немецкий (de) иврит (iw) хинди (hi) венгерский (hu) индонезийский (id) итальянский ( it) Японский (ja) Корейский (ko) Норвежский (букмол) (no) Польский (pl) Португальский (Бразилия) (pt-BR) Португальский (Португалия) (pt-PT) Русский (ru) Испанский (es) Испанский (латиница) Америка) (es-419) Шведский (sv) Тайский (th) Турецкий (tr) Украинский (uk) Вьетнамский (vi)

googleWorkspaceAccount

object ( GoogleWorkspaceAccount )

Только вывод. Аккаунт Google Workspace, связанный с этим клиентом. Используется только для компаний-клиентов.

УсловияСтатус

Принятие компанией Условий обслуживания (ToS) автоматической регистрации. Один пользователь может принять ToS для своей компании с помощью веб-портала.

Условия использования имеют версии. Это означает, что при изменении УО по крайней мере один пользователь должен принять новое УО. Пока первый пользователь не примет новые Условия использования, статус условий компании будет TERMS_STATUS_STALE .

перечисления
TERMS_STATUS_NOT_ACCEPTED Ни один из пользователей компании не принял Условия использования.
TERMS_STATUS_ACCEPTED Один (или несколько) пользователей компании принял Условия использования.
TERMS_STATUS_STALE Ни один из пользователей компании не принял текущие Условия использования, но по крайней мере один пользователь принял предыдущие Условия использования.

Аккаунт GoogleWorkspace

Клиент Google Workspace.

Представление JSON
{
  "customerId": string,
  "preProvisioningTokens": [
    string
  ]
}
Поля
customerId

string

Необходимый. Идентификатор клиента.

preProvisioningTokens[]

string

Только вывод. Токены предварительной подготовки, которые ранее использовались для утверждения устройств.

Методы

create

 Создает клиента для автоматической регистрации.

list

 Список клиентов, зарегистрированных для торгового посредника, указанного аргументом partnerId .