REST Resource: customers

  • This document describes the Company resource, representing a reseller, vendor, or customer in the zero-touch reseller and customer APIs.

  • The Company resource includes fields like name, companyId, companyName, skipWelcomeEmail, languageCode, and a nested googleWorkspaceAccount object, all of which are detailed in the provided table.

  • The GoogleWorkspaceAccount resource, which is related to a company, is defined by a customerId and an array of preProvisioningTokens.

  • The document outlines a method for listing customer accounts via the list method, found under the Methods section.

Resource: Company

A reseller, vendor, or customer in the zero-touch reseller and customer APIs.

JSON representation 
{
  "name": string,
  "companyId": string,
  "companyName": string,
  "skipWelcomeEmail": boolean,
  "languageCode": string,
  "googleWorkspaceAccount": {
    object (GoogleWorkspaceAccount)
  }
}
Fields
name

string

Output only. The API resource name of the company in the format customers/[CUSTOMER_ID]. Assigned by the server.
companyId

string (int64 format)

Output only. The ID of the company. Assigned by the server.
companyName

string

Required. The name of the company. For example XYZ Corp. Displayed to the company's employees in the zero-touch enrollment portal.
skipWelcomeEmail

boolean

Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer.
languageCode

string

Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)
googleWorkspaceAccount

object (GoogleWorkspaceAccount)

Output only. The Google Workspace account associated with this customer. Only used for customer Companies.

GoogleWorkspaceAccount

A Google Workspace customer.

JSON representation 
{
  "customerId": string,
  "preProvisioningTokens": [
    string
  ]
}
Fields
customerId

string

Required. The customer ID.
preProvisioningTokens[]

string

Output only. The pre-provisioning tokens previously used to claim devices.

Methods

list

 Lists the user's customer accounts.