REST Resource: customers.configurations

资源:Configuration

配置会收集 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

更新配置的字段值。