blob: ffacc36642024cd5277e4dec035502bb30833a5c [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="androidmanagement_v1.html">Android Management API</a> . <a href="androidmanagement_v1.enterprises.html">enterprises</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="androidmanagement_v1.enterprises.applications.html">applications()</a></code>
79</p>
80<p class="firstline">Returns the applications Resource.</p>
81
82<p class="toc_element">
83 <code><a href="androidmanagement_v1.enterprises.devices.html">devices()</a></code>
84</p>
85<p class="firstline">Returns the devices Resource.</p>
86
87<p class="toc_element">
88 <code><a href="androidmanagement_v1.enterprises.enrollmentTokens.html">enrollmentTokens()</a></code>
89</p>
90<p class="firstline">Returns the enrollmentTokens Resource.</p>
91
92<p class="toc_element">
93 <code><a href="androidmanagement_v1.enterprises.policies.html">policies()</a></code>
94</p>
95<p class="firstline">Returns the policies Resource.</p>
96
97<p class="toc_element">
98 <code><a href="androidmanagement_v1.enterprises.webApps.html">webApps()</a></code>
99</p>
100<p class="firstline">Returns the webApps Resource.</p>
101
102<p class="toc_element">
103 <code><a href="androidmanagement_v1.enterprises.webTokens.html">webTokens()</a></code>
104</p>
105<p class="firstline">Returns the webTokens Resource.</p>
106
107<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108 <code><a href="#close">close()</a></code></p>
109<p class="firstline">Close httplib2 connections.</p>
110<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800111 <code><a href="#create">create(agreementAccepted=None, body=None, enterpriseToken=None, projectId=None, signupUrlName=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112<p class="firstline">Creates an enterprise. This is the last step in the enterprise signup flow.</p>
113<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800114 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
115<p class="firstline">This feature is not generally available yet. Deletes an enterprise.</p>
116<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
118<p class="firstline">Gets an enterprise.</p>
119<p class="toc_element">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800120 <code><a href="#list">list(pageSize=None, pageToken=None, projectId=None, view=None, x__xgafv=None)</a></code></p>
121<p class="firstline">This feature is not generally available yet. Lists enterprises that are managed by an EMM. Only partial views are returned.</p>
122<p class="toc_element">
123 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
124<p class="firstline">Retrieves the next page of results.</p>
125<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700126 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700127<p class="firstline">Updates an enterprise.</p>
128<h3>Method Details</h3>
129<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700130 <code class="details" id="close">close()</code>
131 <pre>Close httplib2 connections.</pre>
132</div>
133
134<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800135 <code class="details" id="create">create(agreementAccepted=None, body=None, enterpriseToken=None, projectId=None, signupUrlName=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700136 <pre>Creates an enterprise. This is the last step in the enterprise signup flow.
137
138Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700139 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700140 The object takes the form of:
141
142{ # The configuration applied to an enterprise.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800143 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800144 &quot;contactInfo&quot;: { # Contact details for LaForge enterprises. # This feature is not generally available yet. The enterprise contact info of an EMM owned enterprise
145 &quot;contactEmail&quot;: &quot;A String&quot;, # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
146 &quot;dataProtectionOfficerEmail&quot;: &quot;A String&quot;, # The email of the data protection officer. The email is validated but not verified.
147 &quot;dataProtectionOfficerName&quot;: &quot;A String&quot;, # The name of the data protection officer.
148 &quot;dataProtectionOfficerPhone&quot;: &quot;A String&quot;, # The phone number of the data protection officer The phone number is validated but not verified.
149 &quot;euRepresentativeEmail&quot;: &quot;A String&quot;, # The email of the EU representative. The email is validated but not verified.
150 &quot;euRepresentativeName&quot;: &quot;A String&quot;, # The name of the EU representative.
151 &quot;euRepresentativePhone&quot;: &quot;A String&quot;, # The phone number of the EU representative. The phone number is validated but not verified.
152 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800153 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
154 &quot;A String&quot;,
155 ],
156 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
157 &quot;logo&quot;: { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
158 &quot;sha256Hash&quot;: &quot;A String&quot;, # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn&#x27;t match this hash, Android Device Policy won&#x27;t use the data.
159 &quot;url&quot;: &quot;A String&quot;, # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn&#x27;t provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
160 },
161 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
162 &quot;primaryColor&quot;: 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red &lt;&lt; 16) | (green &lt;&lt; 8) | blue, where the value of each component is between 0 and 255, inclusive.
163 &quot;pubsubTopic&quot;: &quot;A String&quot;, # The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
164 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
165 { # A resource containing sign in details for an enterprise.
166 &quot;allowPersonalUsage&quot;: &quot;A String&quot;, # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
167 &quot;qrCode&quot;: &quot;A String&quot;, # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
168 &quot;signinEnrollmentToken&quot;: &quot;A String&quot;, # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
169 &quot;signinUrl&quot;: &quot;A String&quot;, # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800170 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800171 ],
172 &quot;termsAndConditions&quot;: [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
173 { # A terms and conditions page to be accepted during provisioning.
174 &quot;content&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
175 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
176 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
177 &quot;a_key&quot;: &quot;A String&quot;,
178 },
179 },
180 &quot;header&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
181 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
182 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
183 &quot;a_key&quot;: &quot;A String&quot;,
184 },
185 },
186 },
187 ],
188}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700189
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800190 agreementAccepted: boolean, This feature is not generally available yet. Whether the managed Google Play Agreement is presented and agreed.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800191 enterpriseToken: string, The enterprise token appended to the callback URL.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800192 projectId: string, The ID of the Google Cloud Platform project which will own the enterprise.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800193 signupUrlName: string, The name of the SignupUrl used to sign up for the enterprise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199Returns:
200 An object of the form:
201
202 { # The configuration applied to an enterprise.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800203 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800204 &quot;contactInfo&quot;: { # Contact details for LaForge enterprises. # This feature is not generally available yet. The enterprise contact info of an EMM owned enterprise
205 &quot;contactEmail&quot;: &quot;A String&quot;, # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
206 &quot;dataProtectionOfficerEmail&quot;: &quot;A String&quot;, # The email of the data protection officer. The email is validated but not verified.
207 &quot;dataProtectionOfficerName&quot;: &quot;A String&quot;, # The name of the data protection officer.
208 &quot;dataProtectionOfficerPhone&quot;: &quot;A String&quot;, # The phone number of the data protection officer The phone number is validated but not verified.
209 &quot;euRepresentativeEmail&quot;: &quot;A String&quot;, # The email of the EU representative. The email is validated but not verified.
210 &quot;euRepresentativeName&quot;: &quot;A String&quot;, # The name of the EU representative.
211 &quot;euRepresentativePhone&quot;: &quot;A String&quot;, # The phone number of the EU representative. The phone number is validated but not verified.
212 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800213 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
214 &quot;A String&quot;,
215 ],
216 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
217 &quot;logo&quot;: { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
218 &quot;sha256Hash&quot;: &quot;A String&quot;, # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn&#x27;t match this hash, Android Device Policy won&#x27;t use the data.
219 &quot;url&quot;: &quot;A String&quot;, # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn&#x27;t provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
220 },
221 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
222 &quot;primaryColor&quot;: 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red &lt;&lt; 16) | (green &lt;&lt; 8) | blue, where the value of each component is between 0 and 255, inclusive.
223 &quot;pubsubTopic&quot;: &quot;A String&quot;, # The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
224 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
225 { # A resource containing sign in details for an enterprise.
226 &quot;allowPersonalUsage&quot;: &quot;A String&quot;, # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
227 &quot;qrCode&quot;: &quot;A String&quot;, # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
228 &quot;signinEnrollmentToken&quot;: &quot;A String&quot;, # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
229 &quot;signinUrl&quot;: &quot;A String&quot;, # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
230 },
231 ],
232 &quot;termsAndConditions&quot;: [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
233 { # A terms and conditions page to be accepted during provisioning.
234 &quot;content&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
235 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
236 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
237 &quot;a_key&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800238 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800239 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800240 &quot;header&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
241 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
242 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
243 &quot;a_key&quot;: &quot;A String&quot;,
244 },
245 },
246 },
247 ],
248}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700249</div>
250
251<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800252 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
253 <pre>This feature is not generally available yet. Deletes an enterprise.
254
255Args:
256 name: string, This feature is not generally available yet. The name of the enterprise in the form enterprises/{enterpriseId}. (required)
257 x__xgafv: string, V1 error format.
258 Allowed values
259 1 - v1 error format
260 2 - v2 error format
261
262Returns:
263 An object of the form:
264
265 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
266}</pre>
267</div>
268
269<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700270 <code class="details" id="get">get(name, x__xgafv=None)</code>
271 <pre>Gets an enterprise.
272
273Args:
274 name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
275 x__xgafv: string, V1 error format.
276 Allowed values
277 1 - v1 error format
278 2 - v2 error format
279
280Returns:
281 An object of the form:
282
283 { # The configuration applied to an enterprise.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800284 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800285 &quot;contactInfo&quot;: { # Contact details for LaForge enterprises. # This feature is not generally available yet. The enterprise contact info of an EMM owned enterprise
286 &quot;contactEmail&quot;: &quot;A String&quot;, # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
287 &quot;dataProtectionOfficerEmail&quot;: &quot;A String&quot;, # The email of the data protection officer. The email is validated but not verified.
288 &quot;dataProtectionOfficerName&quot;: &quot;A String&quot;, # The name of the data protection officer.
289 &quot;dataProtectionOfficerPhone&quot;: &quot;A String&quot;, # The phone number of the data protection officer The phone number is validated but not verified.
290 &quot;euRepresentativeEmail&quot;: &quot;A String&quot;, # The email of the EU representative. The email is validated but not verified.
291 &quot;euRepresentativeName&quot;: &quot;A String&quot;, # The name of the EU representative.
292 &quot;euRepresentativePhone&quot;: &quot;A String&quot;, # The phone number of the EU representative. The phone number is validated but not verified.
293 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800294 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
295 &quot;A String&quot;,
296 ],
297 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
298 &quot;logo&quot;: { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
299 &quot;sha256Hash&quot;: &quot;A String&quot;, # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn&#x27;t match this hash, Android Device Policy won&#x27;t use the data.
300 &quot;url&quot;: &quot;A String&quot;, # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn&#x27;t provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
301 },
302 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
303 &quot;primaryColor&quot;: 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red &lt;&lt; 16) | (green &lt;&lt; 8) | blue, where the value of each component is between 0 and 255, inclusive.
304 &quot;pubsubTopic&quot;: &quot;A String&quot;, # The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
305 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
306 { # A resource containing sign in details for an enterprise.
307 &quot;allowPersonalUsage&quot;: &quot;A String&quot;, # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
308 &quot;qrCode&quot;: &quot;A String&quot;, # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
309 &quot;signinEnrollmentToken&quot;: &quot;A String&quot;, # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
310 &quot;signinUrl&quot;: &quot;A String&quot;, # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
311 },
312 ],
313 &quot;termsAndConditions&quot;: [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
314 { # A terms and conditions page to be accepted during provisioning.
315 &quot;content&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
316 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
317 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
318 &quot;a_key&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800319 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800320 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800321 &quot;header&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
322 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
323 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
324 &quot;a_key&quot;: &quot;A String&quot;,
325 },
326 },
327 },
328 ],
329}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700330</div>
331
332<div class="method">
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800333 <code class="details" id="list">list(pageSize=None, pageToken=None, projectId=None, view=None, x__xgafv=None)</code>
334 <pre>This feature is not generally available yet. Lists enterprises that are managed by an EMM. Only partial views are returned.
335
336Args:
337 pageSize: integer, This feature is not generally available yet. The requested page size. The actual page size may be fixed to a min or max value.
338 pageToken: string, This feature is not generally available yet. A token identifying a page of results returned by the server.
339 projectId: string, Required. This feature is not generally available yet. The ID of the Cloud project of the EMM the enterprises belongs to.
340 view: string, This feature is not generally available yet. View that specify that partial response should be returned.
341 Allowed values
342 ENTERPRISE_VIEW_UNSPECIFIED - This feature is not generally available yet. The API will default to the BASIC view for the List method.
343 BASIC - This feature is not generally available yet. Includes name and enterprise_display_name fields.
344 x__xgafv: string, V1 error format.
345 Allowed values
346 1 - v1 error format
347 2 - v2 error format
348
349Returns:
350 An object of the form:
351
352 { # This feature is not generally available yet. Response to a request to list enterprises.
353 &quot;enterprises&quot;: [ # This feature is not generally available yet. The list of enterprises.
354 { # The configuration applied to an enterprise.
355 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
356 &quot;contactInfo&quot;: { # Contact details for LaForge enterprises. # This feature is not generally available yet. The enterprise contact info of an EMM owned enterprise
357 &quot;contactEmail&quot;: &quot;A String&quot;, # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
358 &quot;dataProtectionOfficerEmail&quot;: &quot;A String&quot;, # The email of the data protection officer. The email is validated but not verified.
359 &quot;dataProtectionOfficerName&quot;: &quot;A String&quot;, # The name of the data protection officer.
360 &quot;dataProtectionOfficerPhone&quot;: &quot;A String&quot;, # The phone number of the data protection officer The phone number is validated but not verified.
361 &quot;euRepresentativeEmail&quot;: &quot;A String&quot;, # The email of the EU representative. The email is validated but not verified.
362 &quot;euRepresentativeName&quot;: &quot;A String&quot;, # The name of the EU representative.
363 &quot;euRepresentativePhone&quot;: &quot;A String&quot;, # The phone number of the EU representative. The phone number is validated but not verified.
364 },
365 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
366 &quot;A String&quot;,
367 ],
368 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
369 &quot;logo&quot;: { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
370 &quot;sha256Hash&quot;: &quot;A String&quot;, # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn&#x27;t match this hash, Android Device Policy won&#x27;t use the data.
371 &quot;url&quot;: &quot;A String&quot;, # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn&#x27;t provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
372 },
373 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
374 &quot;primaryColor&quot;: 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red &lt;&lt; 16) | (green &lt;&lt; 8) | blue, where the value of each component is between 0 and 255, inclusive.
375 &quot;pubsubTopic&quot;: &quot;A String&quot;, # The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
376 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
377 { # A resource containing sign in details for an enterprise.
378 &quot;allowPersonalUsage&quot;: &quot;A String&quot;, # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
379 &quot;qrCode&quot;: &quot;A String&quot;, # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
380 &quot;signinEnrollmentToken&quot;: &quot;A String&quot;, # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
381 &quot;signinUrl&quot;: &quot;A String&quot;, # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
382 },
383 ],
384 &quot;termsAndConditions&quot;: [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
385 { # A terms and conditions page to be accepted during provisioning.
386 &quot;content&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
387 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
388 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
389 &quot;a_key&quot;: &quot;A String&quot;,
390 },
391 },
392 &quot;header&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
393 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
394 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
395 &quot;a_key&quot;: &quot;A String&quot;,
396 },
397 },
398 },
399 ],
400 },
401 ],
402 &quot;nextPageToken&quot;: &quot;A String&quot;, # This feature is not generally available yet. If there are more results, a token to retrieve next page of results.
403}</pre>
404</div>
405
406<div class="method">
407 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
408 <pre>Retrieves the next page of results.
409
410Args:
411 previous_request: The request for the previous page. (required)
412 previous_response: The response from the request for the previous page. (required)
413
414Returns:
415 A request object that you can call &#x27;execute()&#x27; on to request the next
416 page. Returns None if there are no more items in the collection.
417 </pre>
418</div>
419
420<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700421 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700422 <pre>Updates an enterprise.
423
424Args:
425 name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700426 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700427 The object takes the form of:
428
429{ # The configuration applied to an enterprise.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800430 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800431 &quot;contactInfo&quot;: { # Contact details for LaForge enterprises. # This feature is not generally available yet. The enterprise contact info of an EMM owned enterprise
432 &quot;contactEmail&quot;: &quot;A String&quot;, # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
433 &quot;dataProtectionOfficerEmail&quot;: &quot;A String&quot;, # The email of the data protection officer. The email is validated but not verified.
434 &quot;dataProtectionOfficerName&quot;: &quot;A String&quot;, # The name of the data protection officer.
435 &quot;dataProtectionOfficerPhone&quot;: &quot;A String&quot;, # The phone number of the data protection officer The phone number is validated but not verified.
436 &quot;euRepresentativeEmail&quot;: &quot;A String&quot;, # The email of the EU representative. The email is validated but not verified.
437 &quot;euRepresentativeName&quot;: &quot;A String&quot;, # The name of the EU representative.
438 &quot;euRepresentativePhone&quot;: &quot;A String&quot;, # The phone number of the EU representative. The phone number is validated but not verified.
439 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800440 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
441 &quot;A String&quot;,
442 ],
443 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
444 &quot;logo&quot;: { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
445 &quot;sha256Hash&quot;: &quot;A String&quot;, # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn&#x27;t match this hash, Android Device Policy won&#x27;t use the data.
446 &quot;url&quot;: &quot;A String&quot;, # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn&#x27;t provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
447 },
448 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
449 &quot;primaryColor&quot;: 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red &lt;&lt; 16) | (green &lt;&lt; 8) | blue, where the value of each component is between 0 and 255, inclusive.
450 &quot;pubsubTopic&quot;: &quot;A String&quot;, # The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
451 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
452 { # A resource containing sign in details for an enterprise.
453 &quot;allowPersonalUsage&quot;: &quot;A String&quot;, # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
454 &quot;qrCode&quot;: &quot;A String&quot;, # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
455 &quot;signinEnrollmentToken&quot;: &quot;A String&quot;, # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
456 &quot;signinUrl&quot;: &quot;A String&quot;, # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800457 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800458 ],
459 &quot;termsAndConditions&quot;: [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
460 { # A terms and conditions page to be accepted during provisioning.
461 &quot;content&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
462 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
463 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
464 &quot;a_key&quot;: &quot;A String&quot;,
465 },
466 },
467 &quot;header&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
468 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
469 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
470 &quot;a_key&quot;: &quot;A String&quot;,
471 },
472 },
473 },
474 ],
475}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700476
477 updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
478 x__xgafv: string, V1 error format.
479 Allowed values
480 1 - v1 error format
481 2 - v2 error format
482
483Returns:
484 An object of the form:
485
486 { # The configuration applied to an enterprise.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800487 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800488 &quot;contactInfo&quot;: { # Contact details for LaForge enterprises. # This feature is not generally available yet. The enterprise contact info of an EMM owned enterprise
489 &quot;contactEmail&quot;: &quot;A String&quot;, # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
490 &quot;dataProtectionOfficerEmail&quot;: &quot;A String&quot;, # The email of the data protection officer. The email is validated but not verified.
491 &quot;dataProtectionOfficerName&quot;: &quot;A String&quot;, # The name of the data protection officer.
492 &quot;dataProtectionOfficerPhone&quot;: &quot;A String&quot;, # The phone number of the data protection officer The phone number is validated but not verified.
493 &quot;euRepresentativeEmail&quot;: &quot;A String&quot;, # The email of the EU representative. The email is validated but not verified.
494 &quot;euRepresentativeName&quot;: &quot;A String&quot;, # The name of the EU representative.
495 &quot;euRepresentativePhone&quot;: &quot;A String&quot;, # The phone number of the EU representative. The phone number is validated but not verified.
496 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800497 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
498 &quot;A String&quot;,
499 ],
500 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
501 &quot;logo&quot;: { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
502 &quot;sha256Hash&quot;: &quot;A String&quot;, # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn&#x27;t match this hash, Android Device Policy won&#x27;t use the data.
503 &quot;url&quot;: &quot;A String&quot;, # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn&#x27;t provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
504 },
505 &quot;name&quot;: &quot;A String&quot;, # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
506 &quot;primaryColor&quot;: 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red &lt;&lt; 16) | (green &lt;&lt; 8) | blue, where the value of each component is between 0 and 255, inclusive.
507 &quot;pubsubTopic&quot;: &quot;A String&quot;, # The topic that Cloud Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
508 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
509 { # A resource containing sign in details for an enterprise.
510 &quot;allowPersonalUsage&quot;: &quot;A String&quot;, # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
511 &quot;qrCode&quot;: &quot;A String&quot;, # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
512 &quot;signinEnrollmentToken&quot;: &quot;A String&quot;, # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
513 &quot;signinUrl&quot;: &quot;A String&quot;, # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
514 },
515 ],
516 &quot;termsAndConditions&quot;: [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
517 { # A terms and conditions page to be accepted during provisioning.
518 &quot;content&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
519 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
520 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
521 &quot;a_key&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800522 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800523 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800524 &quot;header&quot;: { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
525 &quot;defaultMessage&quot;: &quot;A String&quot;, # The default message displayed if no localized message is specified or the user&#x27;s locale doesn&#x27;t match with any of the localized messages. A default message must be provided if any localized messages are provided.
526 &quot;localizedMessages&quot;: { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
527 &quot;a_key&quot;: &quot;A String&quot;,
528 },
529 },
530 },
531 ],
532}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700533</div>
534
535</body></html>