Skip to main content

查询应用接口

读取当前组织的开放平台应用，查看应用名称、已授予的 API Scope 和人员访问范围。用于核对应用授权配置，响应不包含 API Key 明文。

  • Scope：admin.v1.apps.read
  • 权限项：应用读取（apps）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/open-platform/apps

认证与请求头

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

请求参数

此接口没有额外请求参数。

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/open-platform/apps' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray ｜ null是记录列表-

items[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
api_scopesarray<string> ｜ null是应用获准使用的 API Scope 列表
created_atstring · date-time是创建时间
created_by_namestring是创建人姓名
descriptionstring是应用说明
idstring是应用 ID
modified_atstring · date-time是修改时间
modified_by_namestring是修改人姓名
namestring是应用名称
statusstring是应用状态
subject_scopeany是应用可访问的用户范围

items[].subject_scope 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
modestring是范围选择模式；可选值：all, departments, groups, users
department_idsarray<string>否部门 ID 列表；mode=departments 时使用
group_idsarray<string>否用户组 ID 列表；mode=groups 时使用
user_idsarray<string>否用户 ID 列表；mode=users 时使用
{
  "items": [
    {
      "api_scopes": [
        "<string>"
      ],
      "created_at": "2026-08-27T10:00:00Z",
      "created_by_name": "<string>",
      "description": "<string>",
      "id": "<string>",
      "modified_at": "2026-08-27T10:00:00Z",
      "modified_by_name": "<string>",
      "name": "<string>",
      "status": "<string>",
      "subject_scope": "<string>"
    }
  ]
}

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>"
}