blob: 198a2645009c2414957c6244b714d363e7e52913 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="androiddeviceprovisioning_v1.html">Android Device Provisioning Partner API</a> . <a href="androiddeviceprovisioning_v1.partners.html">partners</a> . <a href="androiddeviceprovisioning_v1.partners.customers.html">customers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070080<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070081 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.</p>
83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080084 <code><a href="#list">list(partnerId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">Lists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <pre>Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098
99Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100 parent: string, Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700101 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102 The object takes the form of:
103
104{ # Request message to create a customer.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800105 &quot;customer&quot;: { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs. # Required. The company data to populate the new customer. Must contain a value for `companyName` and at least one `owner_email` that&#x27;s associated with a Google Account. The values for `companyId` and `name` must be empty.
106 &quot;adminEmails&quot;: [ # Optional. Email address of customer&#x27;s users in the admin role. Each email address must be associated with a Google Account.
107 &quot;A String&quot;,
108 ],
109 &quot;companyId&quot;: &quot;A String&quot;, # Output only. The ID of the company. Assigned by the server.
110 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the company. For example _XYZ Corp_. Displayed to the company&#x27;s employees in the zero-touch enrollment portal.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700111 &quot;languageCode&quot;: &quot;A String&quot;, # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800112 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700113 &quot;ownerEmails&quot;: [ # Required. Input only. Email address of customer&#x27;s users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization&#x27;s portal users.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800114 &quot;A String&quot;,
115 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700116 &quot;skipWelcomeEmail&quot;: True or False, # Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800117 &quot;termsStatus&quot;: &quot;A String&quot;, # Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
118 },
119}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120
121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126Returns:
127 An object of the form:
128
129 { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800130 &quot;adminEmails&quot;: [ # Optional. Email address of customer&#x27;s users in the admin role. Each email address must be associated with a Google Account.
131 &quot;A String&quot;,
132 ],
133 &quot;companyId&quot;: &quot;A String&quot;, # Output only. The ID of the company. Assigned by the server.
134 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the company. For example _XYZ Corp_. Displayed to the company&#x27;s employees in the zero-touch enrollment portal.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700135 &quot;languageCode&quot;: &quot;A String&quot;, # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800136 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700137 &quot;ownerEmails&quot;: [ # Required. Input only. Email address of customer&#x27;s users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization&#x27;s portal users.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 &quot;A String&quot;,
139 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700140 &quot;skipWelcomeEmail&quot;: True or False, # Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800141 &quot;termsStatus&quot;: &quot;A String&quot;, # Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
142}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700143</div>
144
145<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800146 <code class="details" id="list">list(partnerId, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700147 <pre>Lists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700148
149Args:
150 partnerId: string, Required. The ID of the reseller partner. (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800151 pageSize: integer, The maximum number of results to be returned. If not specified or 0, all the records are returned.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800152 pageToken: string, A token identifying a page of results returned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158Returns:
159 An object of the form:
160
161 { # Response message of all customers related to this partner.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800162 &quot;customers&quot;: [ # List of customers related to this reseller partner.
163 { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
164 &quot;adminEmails&quot;: [ # Optional. Email address of customer&#x27;s users in the admin role. Each email address must be associated with a Google Account.
165 &quot;A String&quot;,
166 ],
167 &quot;companyId&quot;: &quot;A String&quot;, # Output only. The ID of the company. Assigned by the server.
168 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the company. For example _XYZ Corp_. Displayed to the company&#x27;s employees in the zero-touch enrollment portal.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700169 &quot;languageCode&quot;: &quot;A String&quot;, # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800170 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700171 &quot;ownerEmails&quot;: [ # Required. Input only. Email address of customer&#x27;s users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization&#x27;s portal users.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800172 &quot;A String&quot;,
173 ],
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700174 &quot;skipWelcomeEmail&quot;: True or False, # Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800175 &quot;termsStatus&quot;: &quot;A String&quot;, # Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
176 },
177 ],
178 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Omitted if no further results are available.
179 &quot;totalSize&quot;: 42, # The total count of items in the list irrespective of pagination.
180}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700181</div>
182
183<div class="method">
184 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
185 <pre>Retrieves the next page of results.
186
187Args:
188 previous_request: The request for the previous page. (required)
189 previous_response: The response from the request for the previous page. (required)
190
191Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700192 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700193 page. Returns None if there are no more items in the collection.
194 </pre>
195</div>
196
197</body></html>