Skip to main content

查询可信设备策略接口

读取可信设备策略,查看可信校验开关、首台设备自动信任设置、适用范围及优先级。返回的 version 用于后续更新或删除时校验并发变更。

  • Scope:admin.v1.trusted-device-policies.read
  • 权限项:可信设备策略读取(trusted-device-policies)
  • 权限类型:读取
  • 接口:GET/api/openapi/v1/trusted-device-policies

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope;读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key,使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/trusted-device-policies?page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray<OpenapifacadeTrustedDevicePolicyResponse>是记录列表-
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
totalinteger · int64是总条数0

items[] 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
created_atstring | null · date-time是创建时间
created_bystring | null · uuid否创建人 ID
created_by_emailstring否创建人邮箱
created_by_namestring否创建人
descriptionstring是策略组说明
first_device_auto_trustboolean是首台设备免导入
idstring · uuid是策略组 ID
is_defaultboolean是是否为默认策略组
namestring是策略组名称
priorityinteger | null · int64是优先级
scope_typestring是用户范围类型;可选值:all, specified
subjectsarray<object>是指定用户范围
updated_atstring | null · date-time是更新时间
updated_bystring | null · uuid否更新人 ID
updated_by_emailstring否更新人邮箱
updated_by_namestring否更新人
validation_enabledboolean是启用可信设备验证
versioninteger · int64是版本号,用于并发更新校验

items[].subjects[] 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
idstring · uuid是范围对象 ID
namestring是范围对象名称
typestring是对象类型;可选值:department, user_group, user
{
  "items": [
    {
      "created_at": "2026-08-27T10:00:00Z",
      "created_by": "<uuid>",
      "created_by_email": "<string>",
      "created_by_name": "<string>",
      "description": "<string>",
      "first_device_auto_trust": false,
      "id": "<uuid>",
      "is_default": false,
      "name": "<string>",
      "priority": 0,
      "scope_type": "all",
      "subjects": [
        {
          "id": "<uuid>",
          "name": "<string>",
          "type": "department"
        }
      ],
      "updated_at": "2026-08-27T10:00:00Z",
      "updated_by": "<uuid>",
      "updated_by_email": "<string>",
      "updated_by_name": "<string>",
      "validation_enabled": false,
      "version": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段;父对象可否省略或为 null,以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}

可信设备申请开关

allow_trust_requests 为布尔值,策略响应返回此字段。创建时可选,省略默认为 false;更新时可选,省略保留原值,false 关闭申请,true 开启申请。沿用现有策略校验规则。