REST Resource: enterprises

Resource: Enterprise

The configuration applied to an enterprise.

JSON representation
{
  "name": string,
  "enabledNotificationTypes": [
    enum (NotificationType)
  ],
  "pubsubTopic": string,
  "primaryColor": number,
  "logo": {
    object (ExternalData)
  },
  "enterpriseDisplayName": string,
  "termsAndConditions": [
    {
      object (TermsAndConditions)
    }
  ],
  "appAutoApprovalEnabled": boolean,
  "signinDetails": [
    {
      object (SigninDetail)
    }
  ]
}
Fields
name

string

The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.

enabledNotificationTypes[]

enum (NotificationType)

The types of Google Pub/Sub notifications enabled for the enterprise.

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.

primaryColor

number

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.

enterpriseDisplayName

string

The name of the enterprise displayed to users.

termsAndConditions[]

object (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)

boolean

Deprecated and unused.

signinDetails[]

object (SigninDetail)

Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported.

NotificationType

Types of notifications the device management server may send via Google Cloud 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.

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

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.

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.

TermsAndConditions

A terms and conditions page to be accepted during provisioning.

JSON representation
{
  "header": {
    object (UserFacingMessage)
  },
  "content": {
    object (UserFacingMessage)
  }
}
Fields
header

object (UserFacingMessage)

A short header which appears above the HTML content.

content

object (UserFacingMessage)

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.

JSON representation
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string
}
Fields
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= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.

signinEnrollmentToken

string

An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.

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.

Methods

create

Creates an enterprise.

get

Gets an enterprise.

patch

Updates an enterprise.

Send feedback about...

Android Management API
Android Management API