Skip to main content

发布登录页配置

千问办公企业旗舰版开发者文档:发布登录页配置。

  • Scope: admin.v1.personalization.manage
  • 权限项: 个性化配置管理
  • 权限类型: manage
  • 接口: POST/api/openapi/v1/personalization/configs/login/publications
使用 Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。各 Scope 独立授权。响应不应缓存。 登录页配置对整个组织生效。请先读取当前登录页配置,保留需要沿用的字段,并将读到的 revision 作为 expected_revision 提交。版本冲突返回 409。更换背景图片时,在 config.backgroundUploadId 中填写上传会话返回的 upload_id。

公共请求头

适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:Authorization 必填,X-Request-Id 可选;当前接口所需 Scope 见本页。Idempotency-Key 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。

请求参数

请求体:必填;Content-Type:application/json。
名称位置类型必填说明示例
configbodyobject是分区配置;初始值为 {}-
expected_revisionbodyinteger · int64是最近一次读取的版本号; format="int64", minimum=0-

body.config 字段

字段类型必填说明
backgroundKeystring否服务端管理的背景对象键;编辑时保留
backgroundUploadIdstring · uuid否仅发布请求使用的上传会话 ID; format="uuid"
backgroundUrlstring否背景图片 URL;UI 缺省为品牌背景
descriptionobject | null否说明文本
enabledboolean否是否启用背景;UI 缺省 true
welcomeTitleobject | null否欢迎标题;省略保留已有值,null 清除

body.config.description 字段

字段类型必填说明
enstring否英文文案; maxLength=160
zh-CNstring否简体中文文案; maxLength=160

body.config.welcomeTitle 字段

字段类型必填说明
enstring否英文文案; maxLength=80
zh-CNstring否简体中文文案; maxLength=80

请求示例

curl --request POST \
  --url 'https://example.invalid/api/openapi/v1/personalization/configs/login/publications' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "config": {},
  "expected_revision": 0
}'

响应状态表

HTTP 状态码触发条件响应结构引用客户端处理建议
201请求成功见本文“响应结果”读取响应结果。
default未单独列出的认证、授权、校验或依赖错误见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构按状态与 code 处理;写操作重试前核实结果及幂等要求。

响应结果

Content-Type: application/json
名称类型必填说明示例
configobject是分区配置;初始值为 {}-
product_editionstring否产品部署版本类型; enum=["vpc", "k8s"] 取值:"k8s"、"vpc"-
publication_idstring是发布记录 ID-
published_atstring · date-time是发布时间; format="date-time"-
revisioninteger · int64是当前版本号,用于并发控制; format="int64"-
sectionstring是个性化配置分区-
successboolean是是否成功-

config

字段类型必填说明
backgroundKeystring否服务端管理的背景对象键;编辑时保留
backgroundUrlstring否背景图片 URL;UI 缺省为品牌背景
descriptionobject | null否说明文本
enabledboolean否是否启用背景;UI 缺省 true
welcomeTitleobject | null否欢迎标题;省略保留已有值,null 清除

config.description

字段类型必填说明
enstring否英文文案; maxLength=160
zh-CNstring否简体中文文案; maxLength=160

config.welcomeTitle

字段类型必填说明
enstring否英文文案; maxLength=80
zh-CNstring否简体中文文案; maxLength=80

运行时限制与协议说明

HTTP 409 / personalization_revision_conflict 在服务端知道当前版本时附带 current_revision(integer,可选);未附带时先读取最新配置,不假定其为 0。 登录背景发布返回 422 / personalization_asset_size_mismatch 时,错误根含 declared_size_bytes、actual_size_bytes(integer,均必填,单位字节);422 / personalization_asset_dimensions_invalid 含 minimum_width、minimum_height(integer,均必填,单位像素)。两类详情按 code 区分,不同时声明给所有 422。

错误与重试

保留现有 UI 服务的错误码与校验。401/403 表示认证或授权失败;409 表示冲突,应重新读取后重试;413 表示请求过大;400/422 表示参数校验失败;503 表示依赖不可用。以实际响应及机器契约为准。创建类幂等操作重试应使用相同 Idempotency-Key 与相同请求。

config 字段与默认值

config 保留开放 JSON 对象契约;以下是 main 已有 UI 读写字段,不引入新的服务端必填项。 登录文案不接受其他语言键或非字符串值。发布时省略文案会保留已有值;显式 null 清除。首次读取存储值为 {},UI 展示默认值不代表接口填充默认值。背景文件限制沿用上传会话校验。 以下仅为 config 配置片段,不是完整请求或响应。
{"enabled":true,"welcomeTitle":{"zh-CN":"欢迎","en":"Welcome"},"description":{"zh-CN":"开始办公","en":"Start working"}}