| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 108 | <code><a href="#create">create(body=None, projectId=None, enterpriseToken=None, signupUrlName=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-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'Meara | dd49464 | 2020-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 Kim | 715bd7f | 2019-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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 118 | <code class="details" id="create">create(body=None, projectId=None, enterpriseToken=None, signupUrlName=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 119 | <pre>Creates an enterprise. This is the last step in the enterprise signup flow. |
| 120 | |
| 121 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 122 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "signinDetails": [ # Sign-in details of the enterprise. |
| 127 | { # A resource containing sign in details for an enterprise. |
| 128 | "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. |
| 129 | "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. |
| 130 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 131 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 132 | ], |
| 133 | "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. |
| 134 | { # A terms and conditions page to be accepted during provisioning. |
| 135 | "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. |
| 136 | "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. |
| 137 | "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. |
| 138 | "a_key": "A String", |
| 139 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 140 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | "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. |
| 142 | "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. |
| 143 | "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. |
| 144 | "a_key": "A String", |
| 145 | }, |
| 146 | }, |
| 147 | }, |
| 148 | ], |
| 149 | "name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. |
| 150 | "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. |
| 151 | "enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise. |
| 152 | "A String", |
| 153 | ], |
| 154 | "enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. |
| 155 | "appAutoApprovalEnabled": True or False, # Deprecated and unused. |
| 156 | "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. |
| 157 | "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. |
| 158 | "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. |
| 159 | "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. |
| 160 | }, |
| 161 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 162 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 163 | projectId: string, The ID of the Google Cloud Platform project which will own the enterprise. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 164 | enterpriseToken: string, The enterprise token appended to the callback URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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 | |
| 171 | Returns: |
| 172 | An object of the form: |
| 173 | |
| 174 | { # The configuration applied to an enterprise. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 175 | "signinDetails": [ # Sign-in details of the enterprise. |
| 176 | { # A resource containing sign in details for an enterprise. |
| 177 | "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. |
| 178 | "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. |
| 179 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 180 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 181 | ], |
| 182 | "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. |
| 183 | { # A terms and conditions page to be accepted during provisioning. |
| 184 | "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. |
| 185 | "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. |
| 186 | "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. |
| 187 | "a_key": "A String", |
| 188 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 189 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 190 | "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. |
| 191 | "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. |
| 192 | "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. |
| 193 | "a_key": "A String", |
| 194 | }, |
| 195 | }, |
| 196 | }, |
| 197 | ], |
| 198 | "name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. |
| 199 | "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. |
| 200 | "enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise. |
| 201 | "A String", |
| 202 | ], |
| 203 | "enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. |
| 204 | "appAutoApprovalEnabled": True or False, # Deprecated and unused. |
| 205 | "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. |
| 206 | "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. |
| 207 | "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. |
| 208 | "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. |
| 209 | }, |
| 210 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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 | |
| 217 | Args: |
| 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 | |
| 224 | Returns: |
| 225 | An object of the form: |
| 226 | |
| 227 | { # The configuration applied to an enterprise. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 228 | "signinDetails": [ # Sign-in details of the enterprise. |
| 229 | { # A resource containing sign in details for an enterprise. |
| 230 | "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. |
| 231 | "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. |
| 232 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 233 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 234 | ], |
| 235 | "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. |
| 236 | { # A terms and conditions page to be accepted during provisioning. |
| 237 | "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. |
| 238 | "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. |
| 239 | "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. |
| 240 | "a_key": "A String", |
| 241 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 242 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 243 | "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. |
| 244 | "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. |
| 245 | "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. |
| 246 | "a_key": "A String", |
| 247 | }, |
| 248 | }, |
| 249 | }, |
| 250 | ], |
| 251 | "name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. |
| 252 | "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. |
| 253 | "enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise. |
| 254 | "A String", |
| 255 | ], |
| 256 | "enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. |
| 257 | "appAutoApprovalEnabled": True or False, # Deprecated and unused. |
| 258 | "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. |
| 259 | "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. |
| 260 | "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. |
| 261 | "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. |
| 262 | }, |
| 263 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 264 | </div> |
| 265 | |
| 266 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 267 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 268 | <pre>Updates an enterprise. |
| 269 | |
| 270 | Args: |
| 271 | name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 272 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 273 | The object takes the form of: |
| 274 | |
| 275 | { # The configuration applied to an enterprise. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 276 | "signinDetails": [ # Sign-in details of the enterprise. |
| 277 | { # A resource containing sign in details for an enterprise. |
| 278 | "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. |
| 279 | "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. |
| 280 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 281 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 282 | ], |
| 283 | "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. |
| 284 | { # A terms and conditions page to be accepted during provisioning. |
| 285 | "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. |
| 286 | "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. |
| 287 | "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. |
| 288 | "a_key": "A String", |
| 289 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 290 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 291 | "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. |
| 292 | "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. |
| 293 | "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. |
| 294 | "a_key": "A String", |
| 295 | }, |
| 296 | }, |
| 297 | }, |
| 298 | ], |
| 299 | "name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. |
| 300 | "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. |
| 301 | "enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise. |
| 302 | "A String", |
| 303 | ], |
| 304 | "enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. |
| 305 | "appAutoApprovalEnabled": True or False, # Deprecated and unused. |
| 306 | "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. |
| 307 | "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. |
| 308 | "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. |
| 309 | "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. |
| 310 | }, |
| 311 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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 | |
| 319 | Returns: |
| 320 | An object of the form: |
| 321 | |
| 322 | { # The configuration applied to an enterprise. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 323 | "signinDetails": [ # Sign-in details of the enterprise. |
| 324 | { # A resource containing sign in details for an enterprise. |
| 325 | "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. |
| 326 | "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. |
| 327 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 328 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 329 | ], |
| 330 | "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. |
| 331 | { # A terms and conditions page to be accepted during provisioning. |
| 332 | "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. |
| 333 | "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. |
| 334 | "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. |
| 335 | "a_key": "A String", |
| 336 | }, |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 337 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 338 | "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. |
| 339 | "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. |
| 340 | "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. |
| 341 | "a_key": "A String", |
| 342 | }, |
| 343 | }, |
| 344 | }, |
| 345 | ], |
| 346 | "name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}. |
| 347 | "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. |
| 348 | "enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise. |
| 349 | "A String", |
| 350 | ], |
| 351 | "enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. |
| 352 | "appAutoApprovalEnabled": True or False, # Deprecated and unused. |
| 353 | "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. |
| 354 | "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. |
| 355 | "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. |
| 356 | "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. |
| 357 | }, |
| 358 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 359 | </div> |
| 360 | |
| 361 | </body></html> |