查询通用设置v3
更新时间 2026-08-10 19:33:14
最近更新时间: 2026-08-10 19:33:14
接口功能介绍
查询通用设置v3
接口约束
无
URI
GET /v3/commonSetting/describe
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| customerCode | String | 企业 ID。云电脑登录账号后缀。 | ||
| phoneRequired | Boolean | 手机号必填。可限制账号激活或绑定时，手机号是否作为必要输入条件。 | ||
| emailRequired | Boolean | 邮箱必选。可限制账号激活或绑定时是否勾选通知邮箱作为账号邮箱。 | ||
| adminActivationPasswordChangeAllowed | Boolean | 管理员激活可改密码。可限制管理员激活且未绑定通知邮箱的用户在客户端自助修改密码的操作权限。 | ||
| clientAutoLoginEnabled | Boolean | 客户端自动登录。为了保障账户安全，建议谨慎使用自动登录功能；预览版和安卓瘦终端 2.9.0 及以上版本支持该策略。 | ||
| userBindingEnabled | Boolean | 用户绑定手机号邮箱。可限制管理台创建的用户在客户端绑定手机号、邮箱的操作。 | ||
| deviceBindEnabled | Boolean | 设备绑定。绑定手机号码时是否需要进行设备验证。 | ||
| twoFactorAuthType | String | 双因子认证登录。开启后，使用账号、手机或邮箱加用户密码登录时，需要通过选择的双因子验证完成登录。可能值： - Disabled：关闭双因子认证。 - Sms：短信认证。 - Email：邮箱认证。 - VirtualMfa：虚拟 MFA 认证。 | ||
| passwordForceUpdateCycle | String | 密码定期强制更新。可强制要求用户在指定周期内修改密码。可能值： - Unlimited：取消密码定期强制更新。 - OneMonth：一个月。 - ThreeMonths：三个月。 - SixMonths：六个月。 - TwelveMonths：十二个月。 | ||
| adminContacts | Array of Objects | 管理员联系方式。相应信息会在客户端展示，方便企业成员联系管理员开通功能或排查问题；最多 20 个联系人。 | adminContacts | |
| remark | String | 备注。租户备注。 |
表 adminContacts
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| name | String | 联系人姓名。 | ||
| phoneNumber | String | 联系人手机号。 | ||
| String | 联系人邮箱。 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"customerCode":"testid121",
"phoneRequired":true,
"emailRequired":true,
"adminActivationPasswordChangeAllowed":true,
"clientAutoLoginEnabled":true,
"userBindingEnabled":true,
"deviceBindEnabled":true,
"twoFactorAuthType":"Disabled",
"passwordForceUpdateCycle":"Unlimited",
"adminContacts":[{
"name":"aaa",
"phoneNumber":"",
"email":"aaaa@aaa.com"
}],
"remark":"备注"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
