Home Guides Reference Support

REST Resource: partners.vendors.customers

Resource: Company

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

JSON representation 
{
  "name": string,
  "companyId": string,
  "companyName": string,
  "ownerEmails": [
    string
  ],
  "adminEmails": [
    string
  ],
  "termsStatus": enum(TermsStatus)
}
Fields
name

string

Output only. The API resource name of the company. The resource name is one of the following formats:

  • partners/[PARTNER_ID]/customers/[CUSTOMER_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]
  • partners/[PARTNER_ID]/vendors/[VENDOR_ID]/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.

ownerEmails[]

string

Input only. Email address of customer's users in the owner role. At least one owner_email is required. Each email address must be associated with a Google Account. Owners share the same access as admins but can also add, delete, and edit your organization's portal users.

adminEmails[]

string

Input only. Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account.

termsStatus

enum(TermsStatus)

Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.

Methods

list

 Lists the customers of the vendor.