Patch
|
|||||
|
|
||||
Updates an enterprise
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage Android devices and apps for your customers
Input
This building block consumes 24 input parameters
| Name | Format | Description |
|---|---|---|
name Required |
STRING |
The name of the enterprise in the form enterprises/{enterpriseId} |
updateMask |
ANY |
The field mask indicating the fields to update. If not set, all modifiable fields will be modified |
appAutoApprovalEnabled |
BOOLEAN |
Deprecated and unused |
enterpriseDisplayName |
STRING |
The name of the enterprise displayed to users |
enabledNotificationTypes[] |
ENUMERATION |
|
pubsubTopic |
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 |
logo |
OBJECT |
Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash |
logo.url |
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 |
logo.sha256Hash |
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 |
signinDetails[] |
OBJECT |
A resource containing sign in details for an enterprise |
signinDetails[].signinEnrollmentToken |
STRING |
An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server |
signinDetails[].qrCode |
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 |
signinDetails[].signinUrl |
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= |
termsAndConditions[] |
OBJECT |
A terms and conditions page to be accepted during provisioning |
termsAndConditions[].content |
OBJECT |
Provides a user-facing message with locale info. The maximum message length is 4096 characters |
termsAndConditions[].content.defaultMessage |
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 |
termsAndConditions[].content.localizedMessages |
OBJECT |
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 |
termsAndConditions[].content.localizedMessages.customKey.value Required |
STRING |
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 |
termsAndConditions[].header |
OBJECT |
Provides a user-facing message with locale info. The maximum message length is 4096 characters |
termsAndConditions[].header.defaultMessage |
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 |
termsAndConditions[].header.localizedMessages |
OBJECT |
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 |
termsAndConditions[].header.localizedMessages.customKey.value Required |
STRING |
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 |
name |
STRING |
The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId} |
primaryColor |
INTEGER |
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 |
= Parameter name
= Format
|
name STRING Required The name of the enterprise in the form enterprises/{enterpriseId} |
|
updateMask ANY The field mask indicating the fields to update. If not set, all modifiable fields will be modified |
|
appAutoApprovalEnabled BOOLEAN Deprecated and unused |
|
enterpriseDisplayName STRING The name of the enterprise displayed to users |
|
enabledNotificationTypes[] ENUMERATION |
|
pubsubTopic 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 |
|
logo OBJECT Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash |
|
logo.url 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 |
|
logo.sha256Hash 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 |
|
signinDetails[] OBJECT A resource containing sign in details for an enterprise |
|
signinDetails[].signinEnrollmentToken STRING An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server |
|
signinDetails[].qrCode 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 |
|
signinDetails[].signinUrl 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= |
|
termsAndConditions[] OBJECT A terms and conditions page to be accepted during provisioning |
|
termsAndConditions[].content OBJECT Provides a user-facing message with locale info. The maximum message length is 4096 characters |
|
termsAndConditions[].content.defaultMessage 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 |
|
termsAndConditions[].content.localizedMessages OBJECT 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 |
|
termsAndConditions[].content.localizedMessages.customKey.value STRING Required 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 |
|
termsAndConditions[].header OBJECT Provides a user-facing message with locale info. The maximum message length is 4096 characters |
|
termsAndConditions[].header.defaultMessage 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 |
|
termsAndConditions[].header.localizedMessages OBJECT 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 |
|
termsAndConditions[].header.localizedMessages.customKey.value STRING Required 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 |
|
name STRING The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId} |
|
primaryColor INTEGER 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 |
Output
This building block provides 22 output parameters
| Name | Format | Description |
|---|---|---|
appAutoApprovalEnabled |
BOOLEAN |
Deprecated and unused |
enterpriseDisplayName |
STRING |
The name of the enterprise displayed to users |
enabledNotificationTypes[] |
ENUMERATION |
|
pubsubTopic |
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 |
logo |
OBJECT |
Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash |
logo.url |
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 |
logo.sha256Hash |
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 |
signinDetails[] |
OBJECT |
A resource containing sign in details for an enterprise |
signinDetails[].signinEnrollmentToken |
STRING |
An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server |
signinDetails[].qrCode |
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 |
signinDetails[].signinUrl |
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= |
termsAndConditions[] |
OBJECT |
A terms and conditions page to be accepted during provisioning |
termsAndConditions[].content |
OBJECT |
Provides a user-facing message with locale info. The maximum message length is 4096 characters |
termsAndConditions[].content.defaultMessage |
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 |
termsAndConditions[].content.localizedMessages |
OBJECT |
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 |
termsAndConditions[].content.localizedMessages.customKey.value |
STRING |
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 |
termsAndConditions[].header |
OBJECT |
Provides a user-facing message with locale info. The maximum message length is 4096 characters |
termsAndConditions[].header.defaultMessage |
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 |
termsAndConditions[].header.localizedMessages |
OBJECT |
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 |
termsAndConditions[].header.localizedMessages.customKey.value |
STRING |
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 |
name |
STRING |
The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId} |
primaryColor |
INTEGER |
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 |
= Parameter name
= Format
|
appAutoApprovalEnabled BOOLEAN Deprecated and unused |
|
enterpriseDisplayName STRING The name of the enterprise displayed to users |
|
enabledNotificationTypes[] ENUMERATION |
|
pubsubTopic 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 |
|
logo OBJECT Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash |
|
logo.url 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 |
|
logo.sha256Hash 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 |
|
signinDetails[] OBJECT A resource containing sign in details for an enterprise |
|
signinDetails[].signinEnrollmentToken STRING An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server |
|
signinDetails[].qrCode 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 |
|
signinDetails[].signinUrl 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= |
|
termsAndConditions[] OBJECT A terms and conditions page to be accepted during provisioning |
|
termsAndConditions[].content OBJECT Provides a user-facing message with locale info. The maximum message length is 4096 characters |
|
termsAndConditions[].content.defaultMessage 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 |
|
termsAndConditions[].content.localizedMessages OBJECT 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 |
|
termsAndConditions[].content.localizedMessages.customKey.value STRING 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 |
|
termsAndConditions[].header OBJECT Provides a user-facing message with locale info. The maximum message length is 4096 characters |
|
termsAndConditions[].header.defaultMessage 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 |
|
termsAndConditions[].header.localizedMessages OBJECT 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 |
|
termsAndConditions[].header.localizedMessages.customKey.value STRING 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 |
|
name STRING The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId} |
|
primaryColor INTEGER 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 |