Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / androiddeviceprovisioning_v1.partners.customers.html
blob: 6942a1772e0cd0f901db5bb4fdb981f3bc104eb2 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates a customer for zero-touch enrollment. After the method returns</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#list">list(partnerId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Lists the customers that are enrolled to the reseller identified by the</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]88 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89 <pre>Creates a customer for zero-touch enrollment. After the method returns
90successfully, admin and owner roles can manage devices and EMM configs
91by calling API methods or using their zero-touch enrollment portal.
92The customer receives an email that welcomes them to zero-touch enrollment
93and explains how to sign into the portal.
94
95Args:
96 parent: string, Required. The parent resource ID in the format `partners/[PARTNER_ID]` that
97identifies the reseller. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]98 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99 The object takes the form of:
100
101{ # Request message to create a customer.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 &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
103 # value for `companyName` and at least one `owner_email` that&#x27;s associated
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 # with a Google Account. The values for `companyId` and `name` must be empty.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name of the company. The resource name is one
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 # of the following formats:
107 #
108 # * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`
109 # * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`
110 # * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]`
111 #
112 # Assigned by the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;termsStatus&quot;: &quot;A String&quot;, # Output only. Whether any user from the company has accepted the latest
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 # Terms of Service (ToS). See
115 # TermsStatus.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]116 &quot;ownerEmails&quot;: [ # Input only. Email address of customer&#x27;s users in the owner role. At least
117 # one `owner_email` is required. Each email address must be associated with a
118 # Google Account. Owners share the same access as admins but can also add,
119 # delete, and edit your organization&#x27;s portal users.
120 &quot;A String&quot;,
121 ],
122 &quot;companyId&quot;: &quot;A String&quot;, # Output only. The ID of the company. Assigned by the server.
123 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the company. For example _XYZ Corp_. Displayed to the
124 # company&#x27;s employees in the zero-touch enrollment portal.
125 &quot;adminEmails&quot;: [ # Optional. Input only. Email address of customer&#x27;s users in the admin role.
126 # Each email address must be associated with a Google Account.
127 &quot;A String&quot;,
128 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 },
130 }
131
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137Returns:
138 An object of the form:
139
140 { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name of the company. The resource name is one
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 # of the following formats:
143 #
144 # * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`
145 # * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`
146 # * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]`
147 #
148 # Assigned by the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 &quot;termsStatus&quot;: &quot;A String&quot;, # Output only. Whether any user from the company has accepted the latest
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 # Terms of Service (ToS). See
151 # TermsStatus.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]152 &quot;ownerEmails&quot;: [ # Input only. Email address of customer&#x27;s users in the owner role. At least
153 # one `owner_email` is required. Each email address must be associated with a
154 # Google Account. Owners share the same access as admins but can also add,
155 # delete, and edit your organization&#x27;s portal users.
156 &quot;A String&quot;,
157 ],
158 &quot;companyId&quot;: &quot;A String&quot;, # Output only. The ID of the company. Assigned by the server.
159 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the company. For example _XYZ Corp_. Displayed to the
160 # company&#x27;s employees in the zero-touch enrollment portal.
161 &quot;adminEmails&quot;: [ # Optional. Input only. Email address of customer&#x27;s users in the admin role.
162 # Each email address must be associated with a Google Account.
163 &quot;A String&quot;,
164 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 }</pre>
166</div>
167
168<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 <code class="details" id="list">list(partnerId, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170 <pre>Lists the customers that are enrolled to the reseller identified by the
171`partnerId` argument. This list includes customers that the reseller
172created and customers that enrolled themselves using the portal.
173
174Args:
175 partnerId: string, Required. The ID of the reseller partner. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]176 pageToken: string, A token identifying a page of results returned by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 pageSize: integer, The maximum number of results to be returned. If not specified or 0, all
178the records are returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 x__xgafv: string, V1 error format.
180 Allowed values
181 1 - v1 error format
182 2 - v2 error format
183
184Returns:
185 An object of the form:
186
187 { # Response message of all customers related to this partner.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]188 &quot;totalSize&quot;: 42, # The total count of items in the list irrespective of pagination.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]189 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Omitted if no further results
190 # are available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]191 &quot;customers&quot;: [ # List of customers related to this reseller partner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name of the company. The resource name is one
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 # of the following formats:
195 #
196 # * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`
197 # * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`
198 # * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]`
199 #
200 # Assigned by the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201 &quot;termsStatus&quot;: &quot;A String&quot;, # Output only. Whether any user from the company has accepted the latest
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 # Terms of Service (ToS). See
203 # TermsStatus.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]204 &quot;ownerEmails&quot;: [ # Input only. Email address of customer&#x27;s users in the owner role. At least
205 # one `owner_email` is required. Each email address must be associated with a
206 # Google Account. Owners share the same access as admins but can also add,
207 # delete, and edit your organization&#x27;s portal users.
208 &quot;A String&quot;,
209 ],
210 &quot;companyId&quot;: &quot;A String&quot;, # Output only. The ID of the company. Assigned by the server.
211 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the company. For example _XYZ Corp_. Displayed to the
212 # company&#x27;s employees in the zero-touch enrollment portal.
213 &quot;adminEmails&quot;: [ # Optional. Input only. Email address of customer&#x27;s users in the admin role.
214 # Each email address must be associated with a Google Account.
215 &quot;A String&quot;,
216 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 },
218 ],
219 }</pre>
220</div>
221
222<div class="method">
223 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
224 <pre>Retrieves the next page of results.
225
226Args:
227 previous_request: The request for the previous page. (required)
228 previous_response: The response from the request for the previous page. (required)
229
230Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 page. Returns None if there are no more items in the collection.
233 </pre>
234</div>
235
236</body></html>