REST Resource: enterprises

资源：企业版

应用于企业的配置。

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)
  },
  "googleAuthenticationSettings": {
    object (GoogleAuthenticationSettings)
  }
}
字段
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（包括这两个数值）之间。
enterpriseDisplayName

string

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

object (TermsAndConditions)

为此企业预配设备时必须接受的条款及条件。系统会为此列表中的每个值生成一个术语页面。
appAutoApprovalEnabled
(deprecated)

boolean

已废弃且未使用。
signinDetails[]

object (SigninDetail)

企业的登录详细信息。
contactInfo

object (ContactInfo)

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

object (GoogleAuthenticationSettings)

Google 提供的用户身份验证设置。

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 设备政策将不会使用相应数据。

TermsAndConditions

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

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

object (UserFacingMessage)

显示在 HTML 内容上方的简短标题。
content

object (UserFacingMessage)

格式正确的 HTML 字符串。系统会在客户端上使用 android.text.Html#fromHtml 对其进行解析。

SigninDetail

包含企业登录详细信息的资源。使用 enterprises 管理给定企业的 SigninDetail。

对于企业，我们可以有任意数量的 SigninDetail，它们通过以下三个字段（signinUrl、allowPersonalUsage、tokenTag）的组合进行唯一标识。您不能创建具有相同 (signinUrl、allowPersonalUsage、tokenTag) 的两个 SigninDetail。（tokenTag 是可选字段）。

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

  • 如果传递存储的 SigninDetail 配置，则会返回相同的 signinEnrollmentToken 和 qrCode。
  • 如果我们传递多个未存储的相同 SigninDetail 配置，它将存储这些 SigninDetail 配置中的第一个。
  • 如果配置已存在，我们无法在特定补丁 API 调用中多次请求该配置，否则会出现重复键错误，并且整个操作将失败。
  • 如果我们从请求中移除某些 SigninDetail 配置，则相应配置也会从存储空间中移除。然后，我们可以针对相同的 SigninDetail 配置请求其他 signinEnrollmentToken 和 qrCode。
JSON 表示法 
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "defaultStatus": enum (SigninDetailDefaultStatus),
  "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)

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

对于公司自有设备：

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

对于个人所有的设备：

  • 启用个人使用后，用户可以在设备上设置工作资料。
  • 停用个人用途后，设备将无法预配。无法在个人所有的设备上停用个人使用。
defaultStatus

enum (SigninDetailDefaultStatus)

可选。是否应默认为企业使用登录网址。将 defaultStatus 设置为 SIGNIN_DETAIL_IS_DEFAULT 的 SigninDetail 用于 Google 账号注册方法。企业的 signinDetails 中只有一个 defaultStatus 可以设置为 SIGNIN_DETAIL_IS_DEFAULT。如果 Enterprise 至少有一个 signinDetails，并且其中没有一个将 defaultStatus 设置为 SIGNIN_DETAIL_IS_DEFAULT，则系统会选择列表中的第一个 signinDetails，并将 defaultStatus 设置为 SIGNIN_DETAIL_IS_DEFAULT。如果未为 Enterprise 指定 signinDetails，则 Google 账号设备注册将失败。
tokenTag

string

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

SigninDetailDefaultStatus

是否应默认为企业使用登录网址。

枚举
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED 等同于 SIGNIN_DETAIL_IS_NOT_DEFAULT。
SIGNIN_DETAIL_IS_DEFAULT 系统会默认为企业使用登录网址。
SIGNIN_DETAIL_IS_NOT_DEFAULT 默认情况下，系统不会为企业使用登录网址。

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

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

GoogleAuthenticationSettings

包含 Google 提供的用户身份验证设置。

JSON 表示法 
{
  "googleAuthenticationRequired": enum (GoogleAuthenticationRequired)
}
字段
googleAuthenticationRequired

enum (GoogleAuthenticationRequired)

仅限输出。用户在注册过程中是否需要通过 Google 进行身份验证。IT 管理员可以指定是否为企业的知识工作者设备启用 Google 身份验证。此值只能通过 Google 管理控制台进行设置。Google 身份验证可与 signinUrl 搭配使用。如果需要 Google 身份验证并指定了 signinUrl，Google 身份验证将在 signinUrl 之前启动。

GoogleAuthenticationRequired

用于设置是否需要为此企业进行 Google 身份验证。

枚举
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED 此值未使用。
NOT_REQUIRED 无需进行 Google 身份验证。
REQUIRED 用户必须通过 Google 成功完成身份验证。

方法

create

 创建企业。

delete

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

get

 获取企业。

list

 列出 EMM 管理的企业。

patch

 更新企业。