Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a customers.transferEntitlements call. If a linked Customer already exists and overwriteIfExists is true, it will update that Customer's data.
Possible error codes:
PERMISSION_DENIED:
The reseller account making the request is different from the reseller account in the API request.
Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channelPartnerId}
Request body
The request body contains data with the following structure:
JSON representation
{"authToken": string,"overwriteIfExists": boolean,"channelPartnerId": string,"customer": string,// Union field customer_identity can be only one of the following:"domain": string,"cloudIdentityId": string,"primaryAdminEmail": string// End of list of possible types for union field customer_identity.}
Fields
authToken
string
Optional. The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.
overwriteIfExists
boolean
Required. Choose to overwrite an existing customer if found. This must be set to true if there is an existing customer with a conflicting region code or domain.
channelPartnerId
string
Optional. Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is required for 2-tier transfer scenarios and can be provided via the request Parent binding as well.
customer
string
Optional. Specifies the customer that will receive imported Cloud Identity information. Format: accounts/{account_id}/customers/{customer_id}
Union field customer_identity. Specifies the identity of the transfer customer. A customer's cloud_identity_id or domain is required to look up the customer's Cloud Identity. For Team customers, only the cloud_identity_id option is valid. customer_identity can be only one of the following:
domain
string
Required. Customer domain.
cloudIdentityId
string
Required. Customer's Cloud Identity ID
primaryAdminEmail
string
Required. Customer's primary admin email.
Response body
If successful, the response body contains an instance of Customer.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-19 UTC."],[[["\u003cp\u003eThis endpoint imports a Customer from Cloud Identity, associated with a provided ID or domain, updating existing Customer data if \u003ccode\u003eoverwriteIfExists\u003c/code\u003e is set to true.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request for this operation is a \u003ccode\u003ePOST\u003c/code\u003e method to the specified URL, which includes a required \u003ccode\u003eparent\u003c/code\u003e path parameter representing the reseller's account or a specific channel partner link.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a \u003ccode\u003eoverwriteIfExists\u003c/code\u003e boolean, which must be true if there is any existing conflicting customer, and specifies the customer identity via either a \u003ccode\u003edomain\u003c/code\u003e, \u003ccode\u003ecloudIdentityId\u003c/code\u003e, or \u003ccode\u003eprimaryAdminEmail\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003ePossible error codes include \u003ccode\u003ePERMISSION_DENIED\u003c/code\u003e, \u003ccode\u003eNOT_FOUND\u003c/code\u003e, \u003ccode\u003eINVALID_ARGUMENT\u003c/code\u003e, and \u003ccode\u003eALREADY_EXISTS\u003c/code\u003e, each indicating different issues such as authorization problems, missing data, or conflicts with existing records.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests will return a Customer object in the response body, and this API operation requires the \u003ccode\u003ehttps://www.googleapis.com/auth/apps.order\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.customers.import\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nImports a [Customer](/channel/docs/reference/rest/v1/accounts.customers#Customer) from the Cloud Identity associated with the provided Cloud Identity ID or domain before a customers.transferEntitlements call. If a linked Customer already exists and overwriteIfExists is true, it will update that Customer's data.\n\nPossible error codes:\n\n- PERMISSION_DENIED:\n - The reseller account making the request is different from the reseller account in the API request.\n - You are not authorized to import the customer. See \u003chttps://support.google.com/channelservices/answer/9759265\u003e\n- NOT_FOUND: Cloud Identity doesn't exist or was deleted.\n- INVALID_ARGUMENT: Required parameters are missing, or the authToken is expired or invalid.\n- ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite.\n\nReturn value: The [Customer](/channel/docs/reference/rest/v1/accounts.customers#Customer).\n\n### HTTP request\n\n`POST https://cloudchannel.googleapis.com/v1/{parent=accounts/*}/customers:import`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Customer](/channel/docs/reference/rest/v1/accounts.customers#Customer).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/apps.order`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
