REST Resource: organizations.locations.customers

Resource: Customer

Contains metadata around a Cloud Controls Partner Customer

JSON representation
{
  "name": string,
  "displayName": string,
  "customerOnboardingState": {
    object (CustomerOnboardingState)
  },
  "isOnboarded": boolean
}
Fields
name

string

Identifier. Format: organizations/{organization}/locations/{location}/customers/{customer}

displayName

string

The customer organization's display name. E.g. "google.com".

customerOnboardingState

object (CustomerOnboardingState)

Container for customer onboarding steps

isOnboarded

boolean

Indicates whether a customer is fully onboarded

CustomerOnboardingState

Container for customer onboarding steps

JSON representation
{
  "onboardingSteps": [
    {
      object (CustomerOnboardingStep)
    }
  ]
}
Fields
onboardingSteps[]

object (CustomerOnboardingStep)

List of customer onboarding steps

CustomerOnboardingStep

Container for customer onboarding information

JSON representation
{
  "step": enum (Step),
  "startTime": string,
  "completionTime": string,
  "completionState": enum (CompletionState)
}
Fields
step

enum (Step)

The onboarding step

startTime

string (Timestamp format)

The starting time of the onboarding step

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".

completionTime

string (Timestamp format)

The completion time of the onboarding step

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".

completionState

enum (CompletionState)

Output only. Current state of the step

Step

Enum for possible onboarding steps

Enums
STEP_UNSPECIFIED Unspecified step
KAJ_ENROLLMENT KAJ Enrollment
CUSTOMER_ENVIRONMENT Customer Environment

Methods

get

Gets details of a single customer

list

Lists customers of a partner identified by its Google Cloud organization ID