mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
401 lines
23 KiB
HTML
401 lines
23 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-cloudchannel1-cli/accounts_customers-import/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Customers Import - Cloudchannel v5.0.4+20240303</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Customers Import";
|
|
var mkdocs_page_input_path = "accounts_customers-import.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-cloudchannel1-cli/accounts_customers-import/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Cloudchannel v5.0.4+20240303
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Accounts</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-channel-partner-repricing-configs-create/">Channel Partner Links Channel Partner Repricing Configs Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-channel-partner-repricing-configs-delete/">Channel Partner Links Channel Partner Repricing Configs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-channel-partner-repricing-configs-get/">Channel Partner Links Channel Partner Repricing Configs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-channel-partner-repricing-configs-list/">Channel Partner Links Channel Partner Repricing Configs List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-channel-partner-repricing-configs-patch/">Channel Partner Links Channel Partner Repricing Configs Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-create/">Channel Partner Links Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-create/">Channel Partner Links Customers Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-delete/">Channel Partner Links Customers Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-get/">Channel Partner Links Customers Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-import/">Channel Partner Links Customers Import</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-list/">Channel Partner Links Customers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-customers-patch/">Channel Partner Links Customers Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-get/">Channel Partner Links Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-list/">Channel Partner Links List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_channel-partner-links-patch/">Channel Partner Links Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_check-cloud-identity-accounts-exist/">Check Cloud Identity Accounts Exist</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-create/">Customers Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-customer-repricing-configs-create/">Customers Customer Repricing Configs Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-customer-repricing-configs-delete/">Customers Customer Repricing Configs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-customer-repricing-configs-get/">Customers Customer Repricing Configs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-customer-repricing-configs-list/">Customers Customer Repricing Configs List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-customer-repricing-configs-patch/">Customers Customer Repricing Configs Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-delete/">Customers Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-activate/">Customers Entitlements Activate</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-cancel/">Customers Entitlements Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-change-offer/">Customers Entitlements Change Offer</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-change-parameters/">Customers Entitlements Change Parameters</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-change-renewal-settings/">Customers Entitlements Change Renewal Settings</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-create/">Customers Entitlements Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-get/">Customers Entitlements Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-list/">Customers Entitlements List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-list-entitlement-changes/">Customers Entitlements List Entitlement Changes</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-lookup-offer/">Customers Entitlements Lookup Offer</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-start-paid-service/">Customers Entitlements Start Paid Service</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-entitlements-suspend/">Customers Entitlements Suspend</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-get/">Customers Get</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Customers Import</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-list/">Customers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-list-purchasable-offers/">Customers List Purchasable Offers</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-list-purchasable-skus/">Customers List Purchasable Skus</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-patch/">Customers Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-provision-cloud-identity/">Customers Provision Cloud Identity</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-query-eligible-billing-accounts/">Customers Query Eligible Billing Accounts</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-transfer-entitlements/">Customers Transfer Entitlements</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_customers-transfer-entitlements-to-google/">Customers Transfer Entitlements To Google</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_list-subscribers/">List Subscribers</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_list-transferable-offers/">List Transferable Offers</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_list-transferable-skus/">List Transferable Skus</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_offers-list/">Offers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_register/">Register</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_report-jobs-fetch-report-results/">Report Jobs Fetch Report Results</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_reports-list/">Reports List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_reports-run/">Reports Run</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_sku-groups-billable-skus-list/">Sku Groups Billable Skus List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_sku-groups-list/">Sku Groups List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../accounts_unregister/">Unregister</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Operations</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_cancel/">Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../operations_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Products</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../products_skus-list/">Skus List</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Cloudchannel v5.0.4+20240303</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Accounts »</li>
|
|
<li>Customers Import</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudchannel1-cli/edit/master/docs/accounts_customers-import.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<p>Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists 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. * You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265 * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/apps.order</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/apps.order</em>.
|
|
You can set the scope for this method like this: <code>cloudchannel1 --scope <scope> accounts customers-import ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>GoogleCloudChannelV1ImportCustomerRequest:
|
|
auth-token: string
|
|
channel-partner-id: string
|
|
cloud-identity-id: string
|
|
customer: string
|
|
domain: string
|
|
overwrite-if-exists: boolean
|
|
|
|
</code></pre>
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r . auth-token=duo</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>channel-partner-id=kasd</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cloud-identity-id=sadipscing</code><ul>
|
|
<li>Required. Customer's Cloud Identity ID</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>customer=tempor</code><ul>
|
|
<li>Optional. Specifies the customer that will receive imported Cloud Identity information. Format: accounts/{account_id}/customers/{customer_id}</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>domain=sea</code><ul>
|
|
<li>Required. Customer domain.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>overwrite-if-exists=false</code><ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../accounts_customers-get/" class="btn btn-neutral float-left" title="Customers Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../accounts_customers-list/" class="btn btn-neutral float-right" title="Customers List">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudchannel1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../accounts_customers-get/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../accounts_customers-list/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme_extra.js" defer></script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|