- Resource: Enterprise
- NotificationType
- ExternalData
- TermsAndConditions
- SigninDetail
- SigninDetailDefaultStatus
- ContactInfo
- GoogleAuthenticationSettings
- GoogleAuthenticationRequired
- Methods
Resource: Enterprise
The configuration applied to an enterprise.
JSON representation |
---|
{ "name": string, "enabledNotificationTypes": [ enum ( |
Fields | |
---|---|
name |
The name of the enterprise which is generated by the server during creation, in the form |
enabledNotificationTypes[] |
The types of Google Pub/Sub notifications enabled for the enterprise. |
pubsubTopic |
The topic which Pub/Sub notifications are published to, in the form |
primaryColor |
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: |
logo |
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. |
enterpriseDisplayName |
The name of the enterprise displayed to users. This field has a maximum length of 100 characters. |
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. |
appAutoApprovalEnabled |
Deprecated and unused. |
signinDetails[] |
Sign-in details of the enterprise. |
contactInfo |
The enterprise contact info of an EMM-managed enterprise. |
googleAuthenticationSettings |
Settings for Google-provided user authentication. |
NotificationType
Types of notifications the device management server may send via Google Pub/Sub.
Enums | |
---|---|
NOTIFICATION_TYPE_UNSPECIFIED |
This value is ignored. |
ENROLLMENT |
A notification sent when a device enrolls. |
COMPLIANCE_REPORT |
Deprecated. |
STATUS_REPORT |
A notification sent when a device issues a status report. |
COMMAND |
A notification sent when a device command has completed. |
USAGE_LOGS |
A notification sent when device sends . |
ExternalData
Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash.
JSON representation |
---|
{ "url": string, "sha256Hash": string } |
Fields | |
---|---|
url |
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. |
sha256Hash |
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. |
TermsAndConditions
A terms and conditions page to be accepted during provisioning.
JSON representation |
---|
{ "header": { object ( |
Fields | |
---|---|
header |
A short header which appears above the HTML content. |
content |
A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml. |
SigninDetail
A resource containing sign in details for an enterprise. Use
to manage enterprises
SigninDetail
s for a given enterprise.
For an enterprise, we can have any number of SigninDetail
s that is uniquely identified by combination of the following three fields (signinUrl
, allowPersonalUsage
, tokenTag
). One cannot create two SigninDetail
s with the same (signinUrl
, allowPersonalUsage
, tokenTag
). (tokenTag
is an optional field).
: The operation updates the current list of Patch
SigninDetails
with the new list of SigninDetails
.
- If the stored
SigninDetail
configuration is passed, it returns the samesigninEnrollmentToken
andqrCode
. - If we pass multiple identical
SigninDetail
configurations that are not stored, it will store the first one amongst thoseSigninDetail
configurations. - if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail.
- If we remove certain
SigninDetail
configuration from the request then it will get removed from the storage. We can then request anothersigninEnrollmentToken
andqrCode
for the sameSigninDetail
configuration.
JSON representation |
---|
{ "signinUrl": string, "signinEnrollmentToken": string, "qrCode": string, "allowPersonalUsage": enum ( |
Fields | |
---|---|
signinUrl |
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= |
signinEnrollmentToken |
An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server. |
qrCode |
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 |
allowPersonalUsage |
Controls whether personal usage is allowed on a device provisioned with this enrollment token. For company-owned devices:
For personally-owned devices:
|
defaultStatus |
Optional. Whether the sign-in URL should be used by default for the enterprise. The |
tokenTag |
An EMM-specified metadata to distinguish between instances of |
SigninDetailDefaultStatus
Whether the sign-in URL should be used by default for the enterprise.
Enums | |
---|---|
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED |
Equivalent to SIGNIN_DETAIL_IS_NOT_DEFAULT . |
SIGNIN_DETAIL_IS_DEFAULT |
The sign-in URL will be used by default for the enterprise. |
SIGNIN_DETAIL_IS_NOT_DEFAULT |
The sign-in URL will not be used by default for the enterprise. |
ContactInfo
Contact details for managed Google Play enterprises.
JSON representation |
---|
{ "contactEmail": string, "dataProtectionOfficerName": string, "dataProtectionOfficerEmail": string, "dataProtectionOfficerPhone": string, "euRepresentativeName": string, "euRepresentativeEmail": string, "euRepresentativePhone": string } |
Fields | |
---|---|
contactEmail |
Email address for a point of contact, which will be used to send important announcements related to managed Google Play. |
dataProtectionOfficerName |
The name of the data protection officer. |
dataProtectionOfficerEmail |
The email of the data protection officer. The email is validated but not verified. |
dataProtectionOfficerPhone |
The phone number of the data protection officer The phone number is validated but not verified. |
euRepresentativeName |
The name of the EU representative. |
euRepresentativeEmail |
The email of the EU representative. The email is validated but not verified. |
euRepresentativePhone |
The phone number of the EU representative. The phone number is validated but not verified. |
GoogleAuthenticationSettings
Contains settings for Google-provided user authentication.
JSON representation |
---|
{
"googleAuthenticationRequired": enum ( |
Fields | |
---|---|
googleAuthenticationRequired |
Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with |
GoogleAuthenticationRequired
Setting for whether Google authentication is required for this enterprise.
Enums | |
---|---|
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED |
This value is not used. |
NOT_REQUIRED |
Google authentication is not required. |
REQUIRED |
User is required to be successfully authenticated by Google. |
Methods |
|
---|---|
|
Creates an enterprise. |
|
Permanently deletes an enterprise and all accounts and data associated with it. |
|
Gets an enterprise. |
|
Lists EMM-managed enterprises. |
|
Updates an enterprise. |