REST Resource: enterprises

资源:Enterprise

应用于企业的配置。

JSON 表示法
{
  "name": string,
  "enabledNotificationTypes": [
    enum (NotificationType)
  ],
  "pubsubTopic": string,
  "primaryColor": integer,
  "logo": {
    object (ExternalData)
  },
  "enterpriseDisplayName": string,
  "termsAndConditions": [
    {
      object (TermsAndConditions)
    }
  ],
  "appAutoApprovalEnabled": boolean,
  "signinDetails": [
    {
      object (SigninDetail)
    }
  ],
  "contactInfo": {
    object (ContactInfo)
  }
}
字段
name

string

服务器在创建过程中生成的企业名称,格式为 enterprises/{enterpriseId}

enabledNotificationTypes[]

enum (NotificationType)

为企业启用的 Google Pub/Sub 通知的类型。

pubsubTopic

string

Pub/Sub 通知发布到的主题,格式为 projects/{project}/topics/{topic}。只有在启用 Pub/Sub 通知时,此字段才是必填字段。

primaryColor

integer

RGB 格式的颜色,表示在设备管理应用界面中显示的主色。颜色组成部分的存储方式如下:(red << 16) | (green << 8) | blue,其中每个组成部分的值都介于 0 和 255 之间(含 0 和 255)。

enterpriseDisplayName

string

向用户显示的企业名称。此字段的最大长度为 100 个字符。

termsAndConditions[]

object (TermsAndConditions)

为此企业配置设备时必须接受的条款及条件。系统会为此列表中的每个值生成一个字词页面。

appAutoApprovalEnabled
(deprecated)

boolean

已弃用且未使用。

signinDetails[]

object (SigninDetail)

企业的登录详细信息。

contactInfo

object (ContactInfo)

受 EMM 管理的企业的企业联系信息。

NotificationType

设备管理服务器可能通过 Google Pub/Sub 发送的通知类型。

枚举
NOTIFICATION_TYPE_UNSPECIFIED 系统会忽略此值。
ENROLLMENT 设备注册时发送通知。
COMPLIANCE_REPORT

已弃用。

STATUS_REPORT 设备发出状态报告时发送通知。
COMMAND 当设备命令完成时发送通知。
USAGE_LOGS 设备发送 BatchUsageLogEvents 时发送通知。

ExternalData

托管在外部位置的数据。这些数据将由 Android Device Policy 下载,并根据哈希值进行验证。

JSON 表示法
{
  "url": string,
  "sha256Hash": string
}
字段
url

string

数据的绝对网址,必须使用 http 或 https 架构。Android Device Policy 不在 GET 请求中提供任何凭据,因此网址必须可公开访问。在网址中包含较长的随机组成部分可能会防止攻击者发现该网址。

sha256Hash

string

网址上托管的内容的 base-64 编码 SHA-256 哈希。如果内容与此哈希不匹配,Android Device Policy 将不会使用相应数据。

TermsAndConditions

配置期间要接受的条款及条件页面。

JSON 表示法
{
  "header": {
    object (UserFacingMessage)
  },
  "content": {
    object (UserFacingMessage)
  }
}
字段
header

object (UserFacingMessage)

显示在 HTML 内容上方的短标头。

content

object (UserFacingMessage)

格式正确的 HTML 字符串。它将使用 android.text.HTML#fromHTML 在客户端上进行解析。

SigninDetail

包含企业登录详情的资源。使用 enterprises 管理指定企业的 SigninDetail

对于企业,可以有任意数量的 SigninDetail,通过由以下三个字段(signinUrlallowPersonalUsagetokenTag)的组合进行唯一标识。一个不能创建两个具有相同(signinUrlallowPersonalUsagetokenTag)的 SigninDetail。(tokenTag 是可选字段)。

Patch:该操作会使用新的 SigninDetails 列表更新 SigninDetails 的当前列表。

  • 如果传递了存储的 SigninDetail 配置,则会返回相同的 signinEnrollmentTokenqrCode
  • 如果我们传递多个未存储的相同 SigninDetail 配置,则会存储这些 SigninDetail 配置中的第一个。
  • 如果配置已存在,我们就无法在特定补丁 API 调用中多次请求该配置,否则就会出现重复的键错误,整个操作都会失败。
  • 如果我们从请求中移除特定的 SigninDetail 配置,那么该配置也会从存储空间中移除。然后,我们可以针对相同的 SigninDetail 配置再次请求 signinEnrollmentTokenqrCode
JSON 表示法
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "tokenTag": string
}
字段
signinUrl

string

为设备配置了登录注册令牌后进行身份验证的登录网址。如果登录成功,登录端点应使用以下形式的网址完成身份验证流程:https://enterprise.google.com/android/enroll?et= ;如果登录失败,请使用 https://enterprise.google.com/android/enroll/invalid 格式。

signinEnrollmentToken

string

用于触发自定义登录流程的企业级注册令牌。这是服务器生成的只读字段。

qrCode

string

一个 JSON 字符串,其 UTF-8 表示法可用于生成二维码,以便使用此注册令牌注册设备。如需使用 NFC 注册设备,NFC 记录必须包含 JSON 中属性的序列化 java.util.Properties 表示法。这是服务器生成的只读字段。

allowPersonalUsage

enum (AllowPersonalUsage)

控制是否允许在配置了此注册令牌的设备上使用个人用途。

对于公司自有设备:

  • 启用个人用途后,用户便可在设备上设置工作资料。
  • 如需停用个人使用功能,用户需要将设备配置为完全受管设备。

对于个人拥有的设备:

  • 启用个人用途后,用户便可在设备上设置工作资料。
  • 停用个人用途后,设备将无法进行配置。个人使用的设备无法用于个人用途。
tokenTag

string

EMM 指定的元数据,用于区分 SigninDetail 的实例。

ContactInfo

Google Play 企业版企业的详细联系信息。

JSON 表示法
{
  "contactEmail": string,
  "dataProtectionOfficerName": string,
  "dataProtectionOfficerEmail": string,
  "dataProtectionOfficerPhone": string,
  "euRepresentativeName": string,
  "euRepresentativeEmail": string,
  "euRepresentativePhone": string
}
字段
contactEmail

string

联系人的电子邮件地址,用于发送与 Google Play 企业版相关的重要通知。

dataProtectionOfficerName

string

数据保护官的姓名。

dataProtectionOfficerEmail

string

数据保护官的电子邮件地址。此电子邮件地址已通过验证,但尚未验证。

dataProtectionOfficerPhone

string

数据保护官的电话号码。该电话号码已经过验证,但尚未验证。

euRepresentativeName

string

欧盟代表的姓名。

euRepresentativeEmail

string

欧盟代表的电子邮件地址。此电子邮件地址已通过验证,但尚未验证。

euRepresentativePhone

string

欧盟代表的电话号码。电话号码已通过验证,但尚未验证。

方法

create

创建企业。

delete

永久删除企业及其关联的所有帐号和数据。

get

获取企业。

list

列出 EMM 管理的企业。

patch

更新企业。