NATSoauth.scope.list列出 scope 目录

返回全部可申请的权限范围。

Request Payload

消息格式:JSON

该 jsonschema:parameters 围栏未声明任何属性

Response Payload

回复使用统一信封 {id, code, messages, result},其 result:

NameData TypeRequiredDescription
itemsarrayYesscope 目录
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"
    }
  ]
}

Response Code

回复使用统一信封 {id, code, messages, result},其 code 字段:

code Meaning Notes
0 成功 列出 scope 目录

Examples

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