Method: accounts.listProvisionableCloudIdentityTypes

Returns the Google Workspace customer types you can create for the given domain, and shows if this requires a transfer.

Possible error codes:

  • PERMISSION_DENIED: The reseller account making the request cannot edit this customer.
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.

HTTP request

POST https://cloudchannel.googleapis.com/v1alpha1/{parent=accounts/*}:listProvisionableCloudIdentityTypes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "domain": string,
  "channelPartnerId": string
}
Fields
domain

string

Required. The customer's domain.

channelPartnerId

string

Optional. The Cloud Identity Id of the channel partner under the account to list ProvisionableCloudIdentityTypes for

Response body

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

Response message for CloudChannelService.ListProvisionableCloudIdentityTypes

JSON representation
{
  "cloudIdentityTypes": [
    {
      object (ProvisionableCloudIdentityType)
    }
  ]
}
Fields
cloudIdentityTypes[]

object (ProvisionableCloudIdentityType)

List of cloud identity types and if you can provision them for the domain.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ProvisionableCloudIdentityType

A Cloud identity type, if you can provision it, and why. Used in the accounts.listProvisionableCloudIdentityTypes response.

JSON representation
{
  "customerType": enum (CustomerType),
  "isEligible": boolean,
  "ineligibilityReason": enum (Reason)
}
Fields
customerType

enum (CustomerType)

Customer Type

isEligible

boolean

If you can create a customer with that type.

ineligibilityReason

enum (Reason)

Optional. Only shown if is_allowed = false.

Reason

Enums to represent why the specified customer Type is not eligible for a provision.

Enums
REASON_UNSPECIFIED Reason is not available.
TRANSFER_REQUIRED Transfer is required to have a Cloud Identity with that domain.
DOMAIN_CUSTOMER_EXISTS Reseller already owns a Domain customer with that domain.
TEAM_CUSTOMER_EXISTS Only Team customers can be created for this domain
TAKEOVER_IN_PROGRESS Domain is in the process of converting from Team to Domain.