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"> 108 <code><a href="#create">create(body, enterpriseToken=None, projectId=None, signupUrlName=None, x__xgafv=None)</a></code></p> 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"> 114 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Updates an enterprise.</p> 116<h3>Method Details</h3> 117<div class="method"> 118 <code class="details" id="create">create(body, enterpriseToken=None, projectId=None, signupUrlName=None, x__xgafv=None)</code> 119 <pre>Creates an enterprise. This is the last step in the enterprise signup flow. 120 121Args: 122 body: object, The request body. (required) 123 The object takes the form of: 124 125{ # The configuration applied to an enterprise. 126 "termsAndConditions": [ # 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 "content": { # 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 "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. 130 "localizedMessages": { # A map containing <locale, message> 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. 131 "a_key": "A String", 132 }, 133 }, 134 "header": { # 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 "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. 136 "localizedMessages": { # A map containing <locale, message> 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. 137 "a_key": "A String", 138 }, 139 }, 140 }, 141 ], 142 "name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. 143 "enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise. 144 "A String", 145 ], 146 "primaryColor": 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 << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive. 147 "signinDetails": [ # Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported. 148 { # A resource containing sign in details for an enterprise. 149 "signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server. 150 "qrCode": "A String", # 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 "signinUrl": "A String", # 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=<token> for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login. 152 }, 153 ], 154 "enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. 155 "pubsubTopic": "A String", # 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. 156 "logo": { # 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. 157 "url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn'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. 158 "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. 159 }, 160 "appAutoApprovalEnabled": True or False, # Deprecated and unused. 161 } 162 163 enterpriseToken: string, The enterprise token appended to the callback URL. 164 projectId: string, The ID of the Google Cloud Platform project which will own the enterprise. 165 signupUrlName: string, The name of the SignupUrl used to sign up for the enterprise. 166 x__xgafv: string, V1 error format. 167 Allowed values 168 1 - v1 error format 169 2 - v2 error format 170 171Returns: 172 An object of the form: 173 174 { # The configuration applied to an enterprise. 175 "termsAndConditions": [ # 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. 176 { # A terms and conditions page to be accepted during provisioning. 177 "content": { # 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. 178 "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. 179 "localizedMessages": { # A map containing <locale, message> 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. 180 "a_key": "A String", 181 }, 182 }, 183 "header": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content. 184 "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. 185 "localizedMessages": { # A map containing <locale, message> 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. 186 "a_key": "A String", 187 }, 188 }, 189 }, 190 ], 191 "name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. 192 "enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise. 193 "A String", 194 ], 195 "primaryColor": 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 << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive. 196 "signinDetails": [ # Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported. 197 { # A resource containing sign in details for an enterprise. 198 "signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server. 199 "qrCode": "A String", # 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. 200 "signinUrl": "A String", # 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=<token> for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login. 201 }, 202 ], 203 "enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. 204 "pubsubTopic": "A String", # 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. 205 "logo": { # 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. 206 "url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn'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. 207 "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. 208 }, 209 "appAutoApprovalEnabled": True or False, # Deprecated and unused. 210 }</pre> 211</div> 212 213<div class="method"> 214 <code class="details" id="get">get(name, x__xgafv=None)</code> 215 <pre>Gets an enterprise. 216 217Args: 218 name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required) 219 x__xgafv: string, V1 error format. 220 Allowed values 221 1 - v1 error format 222 2 - v2 error format 223 224Returns: 225 An object of the form: 226 227 { # The configuration applied to an enterprise. 228 "termsAndConditions": [ # 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. 229 { # A terms and conditions page to be accepted during provisioning. 230 "content": { # 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. 231 "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. 232 "localizedMessages": { # A map containing <locale, message> 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. 233 "a_key": "A String", 234 }, 235 }, 236 "header": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content. 237 "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. 238 "localizedMessages": { # A map containing <locale, message> 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. 239 "a_key": "A String", 240 }, 241 }, 242 }, 243 ], 244 "name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. 245 "enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise. 246 "A String", 247 ], 248 "primaryColor": 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 << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive. 249 "signinDetails": [ # Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported. 250 { # A resource containing sign in details for an enterprise. 251 "signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server. 252 "qrCode": "A String", # 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. 253 "signinUrl": "A String", # 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=<token> for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login. 254 }, 255 ], 256 "enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. 257 "pubsubTopic": "A String", # 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. 258 "logo": { # 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. 259 "url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn'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. 260 "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. 261 }, 262 "appAutoApprovalEnabled": True or False, # Deprecated and unused. 263 }</pre> 264</div> 265 266<div class="method"> 267 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 268 <pre>Updates an enterprise. 269 270Args: 271 name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required) 272 body: object, The request body. (required) 273 The object takes the form of: 274 275{ # The configuration applied to an enterprise. 276 "termsAndConditions": [ # 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. 277 { # A terms and conditions page to be accepted during provisioning. 278 "content": { # 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. 279 "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. 280 "localizedMessages": { # A map containing <locale, message> 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. 281 "a_key": "A String", 282 }, 283 }, 284 "header": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content. 285 "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. 286 "localizedMessages": { # A map containing <locale, message> 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. 287 "a_key": "A String", 288 }, 289 }, 290 }, 291 ], 292 "name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. 293 "enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise. 294 "A String", 295 ], 296 "primaryColor": 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 << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive. 297 "signinDetails": [ # Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported. 298 { # A resource containing sign in details for an enterprise. 299 "signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server. 300 "qrCode": "A String", # 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. 301 "signinUrl": "A String", # 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=<token> for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login. 302 }, 303 ], 304 "enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. 305 "pubsubTopic": "A String", # 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. 306 "logo": { # 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. 307 "url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn'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. 308 "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. 309 }, 310 "appAutoApprovalEnabled": True or False, # Deprecated and unused. 311 } 312 313 updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified. 314 x__xgafv: string, V1 error format. 315 Allowed values 316 1 - v1 error format 317 2 - v2 error format 318 319Returns: 320 An object of the form: 321 322 { # The configuration applied to an enterprise. 323 "termsAndConditions": [ # 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. 324 { # A terms and conditions page to be accepted during provisioning. 325 "content": { # 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. 326 "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. 327 "localizedMessages": { # A map containing <locale, message> 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. 328 "a_key": "A String", 329 }, 330 }, 331 "header": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content. 332 "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. 333 "localizedMessages": { # A map containing <locale, message> 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. 334 "a_key": "A String", 335 }, 336 }, 337 }, 338 ], 339 "name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. 340 "enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise. 341 "A String", 342 ], 343 "primaryColor": 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 << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive. 344 "signinDetails": [ # Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported. 345 { # A resource containing sign in details for an enterprise. 346 "signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server. 347 "qrCode": "A String", # 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. 348 "signinUrl": "A String", # 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=<token> for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login. 349 }, 350 ], 351 "enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. 352 "pubsubTopic": "A String", # 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. 353 "logo": { # 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. 354 "url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn'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. 355 "sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. 356 }, 357 "appAutoApprovalEnabled": True or False, # Deprecated and unused. 358 }</pre> 359</div> 360 361</body></html>