GET/api/v1/dev/scopes列出开放平台 scope 目录

Try it 面板需要启用 JavaScript。

返回全部可申请的权限范围及其说明。

Request

Headers

Name	Data Type	Required	Description
Authorization	string	Yes	会话令牌认证，格式 `Bearer <sessionToken>`

type RequestHeaders = {
  /** 会话令牌认证，格式 `Bearer <sessionToken>` */
  Authorization: string
}

Response

Body

Name	Data Type	Required	Description
items	array	Yes	scope 目录

type ResponseBody = {
  /** scope 目录 */
  items: Record<string, unknown>[]
}

{
  "items": [
    {
      "name": "user:profile:read",
      "description": "读取用户基础资料",
      "category": "user"
    },
    {
      "name": "orgs:list",
      "description": "列出用户的组织",
      "category": "orgs"
    },
    {
      "name": "subscriptions:read",
      "description": "读取用户的订阅",
      "category": "subscriptions"
    }
  ]
}

HTTP Code

HTTP Status	Meaning	Notes
200	成功	返回 scope 目录

Response Code

响应使用统一信封 {id, code, messages, result}，其 code 字段：

code	Meaning	Notes
0	成功	返回 scope 目录

Examples

GET /api/v1/dev/scopes
Authorization: Bearer st_7c1f9e05b28d4a63

{
  "id": "01JD8SSHXC6X4ZST",
  "code": 0,
  "messages": [],
  "result": {
    "items": [
      { "name": "user:profile:read", "description": "读取用户基础资料", "category": "user" },
      { "name": "orgs:list", "description": "列出用户的组织", "category": "orgs" },
      { "name": "subscriptions:read", "description": "读取用户的订阅", "category": "subscriptions" }
    ]
  }
}