REST Resource: customers.configurations

资源:配置

配置用于收集 Android 设备的配置选项。每项配置均包含以下几项:

  • 设备上安装的 EMM 设备政策控制器 (DPC)。
  • 在设备上强制执行 EMM 政策。
  • 设备上显示的元数据,用于在设置期间为用户提供帮助。

客户可以根据需要添加任意数量的配置。不过,当客户设置默认配置并应用于该组织购买的所有新设备时,零触摸注册效果最佳。

JSON 表示法
{
  "name": string,
  "configurationId": string,
  "configurationName": string,
  "dpcResourcePath": string,
  "dpcExtras": string,
  "companyName": string,
  "contactEmail": string,
  "contactPhone": string,
  "customMessage": string,
  "isDefault": boolean,
  "forcedResetTime": string
}
字段
name

string

仅限输出。API 资源名称,格式为 customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]。由服务器分配。

configurationId

string (int64 format)

仅限输出。配置的 ID。由服务器分配。

configurationName

string

必需。描述配置用途的简称。例如,“销售团队”或“临时员工”。零触摸注册门户会向 IT 管理员显示此名称。

dpcResourcePath

string

必需。所选 DPC(设备政策控制器)的资源名称,格式为 customers/[CUSTOMER_ID]/dpcs/*。如需列出受支持的 DPC,请调用 customers.dpcs.list

dpcExtras

string

传递给 DPC 的 JSON 格式的 EMM 配置 extra。

companyName

string

必需。组织的名称。在设备配置期间,零触摸注册会向设备用户显示此组织名称。

contactEmail

string

必需。设备用户可联系以获取帮助的电子邮件地址。在配置设备之前,“零触摸注册”会向设备用户显示此电子邮件地址。系统会在输入时验证该值。

contactPhone

string

必需。设备用户可使用其他设备拨打以获取帮助的电话号码。在配置设备之前,零触摸注册会向设备用户显示此号码。接受数字、空格、加号、连字符和括号。

customMessage

string

包含一两句话的消息,目的是帮助设备用户获取帮助或向他们提供有关设备所发生问题的更多详细信息。在配置设备之前,“零触摸注册”会显示此消息。

isDefault

boolean

必需。这是否是将零触摸注册应用于该组织日后购买的任何新设备的默认配置。只能有一个客户配置作为默认配置。将此值设置为 true 会将先前默认配置的 isDefault 值更改为 false

forcedResetTime

string (Duration format)

可选。如果设备未经过设置向导中的配置,则强制将设备恢复出厂设置之前的超时时间,这通常是由于在设置向导运行期间网络连接中断。范围是 0-6 小时,如果未设置,默认值是 2 小时。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

方法

create

创建新配置。

delete

删除未使用的配置。

get

获取配置的详细信息。

list

列出客户的配置。

patch

更新配置的字段值。