REST Resource: accounts.channelPartnerLinks.customers

Resource: Customer

Entity representing a customer of a reseller or distributor.

JSON representation
{
  "name": string,
  "orgDisplayName": string,
  "orgPostalAddress": {
    object (PostalAddress)
  },
  "primaryContactInfo": {
    object (ContactInfo)
  },
  "alternateEmail": string,
  "domain": string,
  "createTime": string,
  "updateTime": string,
  "cloudIdentityId": string,
  "languageCode": string,
  "adminConsoleUrl": string,
  "cloudIdentityInfo": {
    object (CloudIdentityInfo)
  },
  "channelPartnerId": string,
  "correlationId": string
}
Fields
name

string

Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}

orgDisplayName

string

Required. Name of the organization that the customer entity represents.

orgPostalAddress

object (PostalAddress)

Required. The organization address for the customer. To enforce US laws and embargoes, we require a region, postal code, and address lines. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code.

primaryContactInfo

object (ContactInfo)

Primary contact info.

alternateEmail

string

Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.

domain

string

Required. The customer's primary domain. Must match the primary contact email's domain.

createTime

string (Timestamp format)

Output only. Time when the customer was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Time when the customer was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

cloudIdentityId

string

Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.

languageCode

string

Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

adminConsoleUrl
(deprecated)

string

Output only. URL of Customer's Admin console dashboard. Populated only if a Cloud Identity resource exists for this customer. Deprecated: Use CloudIdentityInfo.admin_console_uri instead.

cloudIdentityInfo

object (CloudIdentityInfo)

Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer.

channelPartnerId

string

Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer.

correlationId

string

Optional. External CRM ID for the customer. Populated only if a CRM ID exists for this customer.

ContactInfo

Contact information for a customer account.

JSON representation
{
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "email": string,
  "title": string,
  "phone": string
}
Fields
firstName

string

The customer account contact's first name. Optional for Team customers.

lastName

string

The customer account contact's last name. Optional for Team customers.

displayName

string

Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name.

email

string

The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.

title

string

Optional. The customer account contact's job title.

phone

string

The customer account's contact phone number.

Methods

create

Creates a new Customer resource under the reseller or distributor account.

delete

Deletes the given Customer permanently.

get

Returns the requested Customer resource.

import

Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call.

list

List Customers.

patch

Updates an existing Customer resource for the reseller or distributor.