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)

仅供输出。公司的 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 帐号。仅用于客户公司。

条款状态

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

服务条款具有版本编号。也就是说,如果《服务条款》(ToS) 发生变更,必须至少有一名用户接受新的服务条款。在首位用户接受新版《服务条款》之前,公司的条款状态为 TERMS_STATUS_STALE

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

Google Workspace 帐号

Google Workspace 客户。

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

string

必需。客户 ID。

preProvisioningTokens[]

string

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

方法

create

创建零触摸注册的客户。

list

列出已注册到转销商(通过 partnerId 参数标识)的客户。