Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0bf565cdd7eac073130c7d9700285524a0efd1a3 / . / docs / dyn / androidmanagement_v1.enterprises.html
blob: 87f54478b8604fc9b6097ff7463c37dab173544f [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108 <code><a href="#close">close()</a></code></p>
109<p class="firstline">Close httplib2 connections.</p>
110<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]111 <code><a href="#create">create(body=None, projectId=None, enterpriseToken=None, signupUrlName=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112<p class="firstline">Creates an enterprise. This is the last step in the enterprise signup flow.</p>
113<p class="toc_element">
114 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
115<p class="firstline">Gets an enterprise.</p>
116<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]117 <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]118<p class="firstline">Updates an enterprise.</p>
119<h3>Method Details</h3>
120<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]121 <code class="details" id="close">close()</code>
122 <pre>Close httplib2 connections.</pre>
123</div>
124
125<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]126 <code class="details" id="create">create(body=None, projectId=None, enterpriseToken=None, signupUrlName=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 <pre>Creates an enterprise. This is the last step in the enterprise signup flow.
128
129Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]130 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 The object takes the form of:
132
133{ # The configuration applied to an enterprise.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]134 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
135 { # A resource containing sign in details for an enterprise.
136 &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.
137 &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.
138 &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.
139 &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.
140 },
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;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]144 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]145 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
146 &quot;A String&quot;,
147 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]148 &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.
149 { # A terms and conditions page to be accepted during provisioning.
150 &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.
151 &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.
152 &quot;a_key&quot;: &quot;A String&quot;,
153 },
154 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]155 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]156 &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.
157 &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.
158 &quot;a_key&quot;: &quot;A String&quot;,
159 },
160 &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.
161 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]162 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]163 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]164 &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.
165 &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.
166 &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.
167 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]168 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]169 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]170 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]172 projectId: string, The ID of the Google Cloud Platform project which will own the enterprise.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]173 enterpriseToken: string, The enterprise token appended to the callback URL.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]174 signupUrlName: string, The name of the SignupUrl used to sign up for the enterprise.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
179
180Returns:
181 An object of the form:
182
183 { # The configuration applied to an enterprise.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]184 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
185 { # A resource containing sign in details for an enterprise.
186 &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.
187 &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.
188 &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.
189 &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.
190 },
191 ],
192 &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}.
193 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]194 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]195 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
196 &quot;A String&quot;,
197 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]198 &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.
199 { # A terms and conditions page to be accepted during provisioning.
200 &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.
201 &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.
202 &quot;a_key&quot;: &quot;A String&quot;,
203 },
204 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]205 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]206 &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.
207 &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.
208 &quot;a_key&quot;: &quot;A String&quot;,
209 },
210 &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.
211 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]212 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]213 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]214 &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.
215 &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.
216 &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.
217 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]218 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]219 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]238 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
239 { # A resource containing sign in details for an enterprise.
240 &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.
241 &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.
242 &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.
243 &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.
244 },
245 ],
246 &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}.
247 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]248 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]249 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
250 &quot;A String&quot;,
251 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]252 &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.
253 { # A terms and conditions page to be accepted during provisioning.
254 &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.
255 &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.
256 &quot;a_key&quot;: &quot;A String&quot;,
257 },
258 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]259 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]260 &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.
261 &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.
262 &quot;a_key&quot;: &quot;A String&quot;,
263 },
264 &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.
265 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]266 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]267 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]268 &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.
269 &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.
270 &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.
271 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]272 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]273 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]274 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275</div>
276
277<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]278 <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]279 <pre>Updates an enterprise.
280
281Args:
282 name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]283 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 The object takes the form of:
285
286{ # The configuration applied to an enterprise.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]287 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
288 { # A resource containing sign in details for an enterprise.
289 &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.
290 &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.
291 &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.
292 &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.
293 },
294 ],
295 &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}.
296 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]297 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]298 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
299 &quot;A String&quot;,
300 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]301 &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.
302 { # A terms and conditions page to be accepted during provisioning.
303 &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.
304 &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.
305 &quot;a_key&quot;: &quot;A String&quot;,
306 },
307 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]308 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]309 &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.
310 &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.
311 &quot;a_key&quot;: &quot;A String&quot;,
312 },
313 &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.
314 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]315 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]316 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]317 &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.
318 &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.
319 &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.
320 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]321 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]322 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]323 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324
325 updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
326 x__xgafv: string, V1 error format.
327 Allowed values
328 1 - v1 error format
329 2 - v2 error format
330
331Returns:
332 An object of the form:
333
334 { # The configuration applied to an enterprise.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]335 &quot;signinDetails&quot;: [ # Sign-in details of the enterprise.
336 { # A resource containing sign in details for an enterprise.
337 &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.
338 &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.
339 &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.
340 &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.
341 },
342 ],
343 &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}.
344 &quot;enterpriseDisplayName&quot;: &quot;A String&quot;, # The name of the enterprise displayed to users.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]345 &quot;appAutoApprovalEnabled&quot;: True or False, # Deprecated and unused.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]346 &quot;enabledNotificationTypes&quot;: [ # The types of Google Pub/Sub notifications enabled for the enterprise.
347 &quot;A String&quot;,
348 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]349 &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.
350 { # A terms and conditions page to be accepted during provisioning.
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 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;,
354 },
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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]356 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]357 &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.
358 &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.
359 &quot;a_key&quot;: &quot;A String&quot;,
360 },
361 &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.
362 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]363 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]364 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]365 &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.
366 &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.
367 &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.
368 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]369 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]370 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]371 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]372</div>
373
374</body></html>