Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / androidmanagement_v1.enterprises.html
blob: 5b465ff7cd9f5b0bf551212d2c738c7216e0898f [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="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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]108 <code><a href="#create">create(body=None, signupUrlName=None, enterpriseToken=None, projectId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<p class="firstline">Creates an enterprise. This is the last step in the enterprise signup flow.</p>
110<p class="toc_element">
111 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
112<p class="firstline">Gets an enterprise.</p>
113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]114 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115<p class="firstline">Updates an enterprise.</p>
116<h3>Method Details</h3>
117<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]118 <code class="details" id="create">create(body=None, signupUrlName=None, enterpriseToken=None, projectId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 <pre>Creates an enterprise. This is the last step in the enterprise signup flow.
120
121Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]122 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 The object takes the form of:
124
125{ # The configuration applied to an enterprise.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 &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.
127 { # A terms and conditions page to be accepted during provisioning.
128 &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.
129 &quot;localizedMessages&quot;: { # A map containing &lt;locale, message&gt; 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.
130 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]131 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]132 &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.
133 },
134 &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.
135 &quot;localizedMessages&quot;: { # A map containing &lt;locale, message&gt; 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.
136 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]138 &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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]139 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]141 ],
142 &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}.
143 &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.
144 &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.
145 &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.
146 },
147 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
148 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
149 { # A resource containing sign in details for an enterprise.
150 &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.
151 &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=&lt;token&gt; for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
152 &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.
153 &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:
154 # Enabling personal usage allows the user to set up a work profile on the device.
155 # Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices:
156 # Enabling personal usage allows the user to set up a work profile on the device.
157 # Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
158 },
159 ],
160 &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.
161 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
162 &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.
163 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
164 &quot;A String&quot;,
165 ],
166}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 signupUrlName: string, The name of the SignupUrl used to sign up for the enterprise.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]169 enterpriseToken: string, The enterprise token appended to the callback URL.
170 projectId: string, The ID of the Google Cloud Platform project which will own the enterprise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 x__xgafv: string, V1 error format.
172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
175
176Returns:
177 An object of the form:
178
179 { # The configuration applied to an enterprise.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]180 &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.
181 { # A terms and conditions page to be accepted during provisioning.
182 &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.
183 &quot;localizedMessages&quot;: { # A map containing &lt;locale, message&gt; 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.
184 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]185 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]186 &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.
187 },
188 &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.
189 &quot;localizedMessages&quot;: { # A map containing &lt;locale, message&gt; 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.
190 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]191 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]192 &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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]193 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]195 ],
196 &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}.
197 &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.
198 &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.
199 &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.
200 },
201 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
202 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
203 { # A resource containing sign in details for an enterprise.
204 &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.
205 &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=&lt;token&gt; for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
206 &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.
207 &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:
208 # Enabling personal usage allows the user to set up a work profile on the device.
209 # Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices:
210 # Enabling personal usage allows the user to set up a work profile on the device.
211 # Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
212 },
213 ],
214 &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.
215 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
216 &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.
217 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
218 &quot;A String&quot;,
219 ],
220 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221</div>
222
223<div class="method">
224 <code class="details" id="get">get(name, x__xgafv=None)</code>
225 <pre>Gets an enterprise.
226
227Args:
228 name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
229 x__xgafv: string, V1 error format.
230 Allowed values
231 1 - v1 error format
232 2 - v2 error format
233
234Returns:
235 An object of the form:
236
237 { # The configuration applied to an enterprise.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]238 &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.
239 { # A terms and conditions page to be accepted during provisioning.
240 &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.
241 &quot;localizedMessages&quot;: { # A map containing &lt;locale, message&gt; 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.
242 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]243 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]244 &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.
245 },
246 &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.
247 &quot;localizedMessages&quot;: { # A map containing &lt;locale, message&gt; 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.
248 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]250 &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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]251 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]252 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]253 ],
254 &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}.
255 &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.
256 &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.
257 &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.
258 },
259 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
260 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
261 { # A resource containing sign in details for an enterprise.
262 &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.
263 &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=&lt;token&gt; for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
264 &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.
265 &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:
266 # Enabling personal usage allows the user to set up a work profile on the device.
267 # Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices:
268 # Enabling personal usage allows the user to set up a work profile on the device.
269 # Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
270 },
271 ],
272 &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.
273 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
274 &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.
275 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
276 &quot;A String&quot;,
277 ],
278 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279</div>
280
281<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]282 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 <pre>Updates an enterprise.
284
285Args:
286 name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]287 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288 The object takes the form of:
289
290{ # The configuration applied to an enterprise.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]291 &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.
292 { # A terms and conditions page to be accepted during provisioning.
293 &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.
294 &quot;localizedMessages&quot;: { # A map containing &lt;locale, message&gt; 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.
295 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]296 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]297 &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.
298 },
299 &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.
300 &quot;localizedMessages&quot;: { # A map containing &lt;locale, message&gt; 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.
301 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]302 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]303 &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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]304 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]305 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]306 ],
307 &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}.
308 &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.
309 &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.
310 &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.
311 },
312 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
313 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
314 { # A resource containing sign in details for an enterprise.
315 &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.
316 &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=&lt;token&gt; for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
317 &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.
318 &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:
319 # Enabling personal usage allows the user to set up a work profile on the device.
320 # Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices:
321 # Enabling personal usage allows the user to set up a work profile on the device.
322 # Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
323 },
324 ],
325 &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.
326 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
327 &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.
328 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
329 &quot;A String&quot;,
330 ],
331}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332
333 updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
334 x__xgafv: string, V1 error format.
335 Allowed values
336 1 - v1 error format
337 2 - v2 error format
338
339Returns:
340 An object of the form:
341
342 { # The configuration applied to an enterprise.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]343 &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.
344 { # A terms and conditions page to be accepted during provisioning.
345 &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.
346 &quot;localizedMessages&quot;: { # A map containing &lt;locale, message&gt; 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.
347 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]348 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]349 &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.
350 },
351 &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.
352 &quot;localizedMessages&quot;: { # A map containing &lt;locale, message&gt; 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.
353 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]354 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]355 &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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]356 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]357 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]358 ],
359 &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}.
360 &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.
361 &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.
362 &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.
363 },
364 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
365 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
366 { # A resource containing sign in details for an enterprise.
367 &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.
368 &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=&lt;token&gt; for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
369 &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.
370 &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:
371 # Enabling personal usage allows the user to set up a work profile on the device.
372 # Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices:
373 # Enabling personal usage allows the user to set up a work profile on the device.
374 # Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
375 },
376 ],
377 &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.
378 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
379 &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.
380 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
381 &quot;A String&quot;,
382 ],
383 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]384</div>
385
386</body></html>