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)
  },
  "googleAuthenticationSettings": {
    object (GoogleAuthenticationSettings)
  },
  "enterpriseType": enum (EnterpriseType),
  "managedGooglePlayAccountsEnterpriseType": enum (ManagedGooglePlayAccountsEnterpriseType),
  "managedGoogleDomainType": enum (ManagedGoogleDomainType)
}
字段
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 提供的用户身份验证的设置。
enterpriseType

enum (EnterpriseType)

仅限输出。企业的类型。
managedGooglePlayAccountsEnterpriseType

enum (ManagedGooglePlayAccountsEnterpriseType)

仅限输出。Google Play 企业版账号集的类型。
managedGoogleDomainType

enum (ManagedGoogleDomainType)

仅限输出。受管理的 Google 网域的类型。

NotificationType

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

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

已弃用。
STATUS_REPORT 当设备发出状态报告时发送的通知。
COMMAND 设备命令完成时发送的通知。
USAGE_LOGS 当设备发送 BatchUsageLogEvents 时发送的通知。
ENTERPRISE_UPGRADE 为企业版升级发送的通知。企业升级是指将 Google Play 企业版账号集升级为 Google 企业版域名的过程。

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，这些 SigninDetail 通过以下三个字段（signinUrl、allowPersonalUsage、tokenTag）的组合进行唯一标识。不能创建两个具有相同（signinUrl、allowPersonalUsage、tokenTag）的 SigninDetail。（tokenTag 是一个可选字段）。

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

  • 如果传递的是存储的 SigninDetail 配置，则返回相同的 signinEnrollmentToken 和 qrCode。
  • 如果我们传递多个未存储的相同 SigninDetail 配置，系统将存储这些 SigninDetail 配置中的第一个。
  • 如果配置已存在，我们无法在特定的 PATCH 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)

可选。是否应默认使用企业登录网址。将 SigninDetail 的 defaultStatus 设置为 SIGNIN_DETAIL_IS_DEFAULT 时，该 SigninDetail 用于 Google 账号注册方法。企业的 signinDetails 中只能有一个将 defaultStatus 设置为 SIGNIN_DETAIL_IS_DEFAULT。如果 Enterprise 至少有一个 signinDetails，但没有一个 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，则系统会在启动 signinUrl 之前启动 Google 身份验证。

GoogleAuthenticationRequired

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

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

EnterpriseType

企业的类型。

枚举
ENTERPRISE_TYPE_UNSPECIFIED 未使用此值。
MANAGED_GOOGLE_DOMAIN 企业属于受管理的 Google 网域。
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE 相应企业是 Google Play 企业版账号集。

ManagedGooglePlayAccountsEnterpriseType

Google Play 企业版账号集的类型。

枚举
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE_TYPE_UNSPECIFIED 未指定 Google Play 企业版账号集类型。
CUSTOMER_MANAGED 企业由客户管理
EMM_MANAGED 企业由 EMM 管理（已弃用）。

ManagedGoogleDomainType

受管理的 Google 网域的类型。

枚举
MANAGED_GOOGLE_DOMAIN_TYPE_UNSPECIFIED 未指定受管理的 Google 网域类型。
TYPE_TEAM 受管理的 Google 网域是经过电子邮件验证的团队。
TYPE_DOMAIN 受管理的 Google 网域已通过域名验证。

方法

create

 创建企业。

delete

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

generateEnterpriseUpgradeUrl

 生成企业升级网址，以将现有的 Google Play 企业版账号集升级为 Google 企业版域名。

get

 获取企业。

list

 列出 EMM 管理的企业。

patch

 更新企业。