REST Resource: partners.customers

资源:公司

零触摸转销商 API 和客户 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)

仅限输出。公司的 ID。由服务器分配。

companyName

string

必需。公司的名称。例如 XYZ Corp。在零触摸注册门户网站中向公司的员工显示。

ownerEmails[]

string

必需。仅限输入。拥有所有者角色的客户用户的电子邮件地址。必须至少选择一个 owner_email。所有者与管理员共享相同的访问权限,还可以添加、删除和修改贵组织的门户用户。

adminEmails[]

string

可选。担任管理员角色的客户用户的电子邮件地址。每个电子邮件地址必须与一个 Google 账号相关联。

termsStatus

enum (TermsStatus)

仅限输出。公司是否有任何用户已接受最新的服务条款 (ToS)。请参阅 TermsStatus

skipWelcomeEmail

boolean

仅限输入。如果此政策设为 true,系统将不会向客户发送欢迎电子邮件。如果要通过其他 DEVICE_PROTECTION 服务来认领设备,建议跳过欢迎电子邮件,因为客户将在设备认领时收到另外的电子邮件。如果该客户不是零触摸客户,则此字段会被忽略。

languageCode

string

仅限输入。客户的首选语言区域,以 BCP47 语言代码表示。系统会在您输入时验证此字段,并拒绝包含不受支持的语言代码的请求。

googleWorkspaceAccount

object (GoogleWorkspaceAccount)

仅限输出。与此客户关联的 Google Workspace 账号。仅供客户公司使用。

TermsStatus

公司接受零触摸注册服务条款 (ToS)。单个用户可以使用门户网站为公司接受服务条款。

服务条款带有版本编号。这意味着,当《服务条款》发生变化时,至少有一位用户必须接受新的《服务条款》。在第一位用户接受新的服务条款之前,该公司的条款状态为“TERMS_STATUS_STALE”。

枚举
TERMS_STATUS_NOT_ACCEPTED 该公司的任何用户都尚未接受服务条款。
TERMS_STATUS_ACCEPTED 公司的一位(或多位)用户已接受服务条款。
TERMS_STATUS_STALE 该公司的用户均未接受当前的服务条款,但至少有一位用户接受了之前的服务条款。

GoogleWorkspaceAccount

Google Workspace 客户。

JSON 表示法
{
  "customerId": string,
  "preProvisioningTokens": [
    string
  ]
}
字段
customerId

string

必需。客户 ID。

preProvisioningTokens[]

string

仅限输出。之前用于认领设备的预配置令牌。

方法

create

创建客户以进行零触摸注册。

list

列出已注册到由 partnerId 参数标识的转销商的客户。