Method: accounts.checkCloudIdentityAccountsExist

Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller.

Possible error codes:

  • PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
  • INVALID_VALUE: Invalid domain value in the request.

Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty)

Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain.

HTTP request

POST https://cloudchannel.googleapis.com/v1/{parent=accounts/*}:checkCloudIdentityAccountsExist

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The reseller account's resource name. Parent uses the format: accounts/{account_id}

Request body

The request body contains data with the following structure:

JSON representation
{
  "domain": string
}
Fields
domain

string

Required. Domain to fetch for Cloud Identity account customer.

Response body

If successful, the response body contains data with the following structure:

Response message for CloudChannelService.CheckCloudIdentityAccountsExist.

JSON representation
{
  "cloudIdentityAccounts": [
    {
      object (CloudIdentityCustomerAccount)
    }
  ]
}
Fields
cloudIdentityAccounts[]

object (CloudIdentityCustomerAccount)

The Cloud Identity accounts associated with the domain.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/apps.order

For more information, see the Authentication Overview.

CloudIdentityCustomerAccount

Entity representing a Cloud Identity account that may be associated with a Channel Services API partner.

JSON representation
{
  "existing": boolean,
  "owned": boolean,
  "customerName": string,
  "customerCloudIdentityId": string
}
Fields
existing

boolean

Returns true if a Cloud Identity account exists for a specific domain.

owned

boolean

Returns true if the Cloud Identity account is associated with a customer of the Channel Services partner.

customerName

string

If owned = true, the name of the customer that owns the Cloud Identity account. Customer_name uses the format: accounts/{account_id}/customers/{customer_id}

customerCloudIdentityId

string

If existing = true, the Cloud Identity ID of the customer.