scopes.ts
OAuth 2.0 授权范围配置项的字段和模板默认配置。
config/scopes.ts 导出一个 Record<string, { name: LocalizedText; description: LocalizedText; priority?: number }> 对象,每个 Key 对应一项授权范围(Scope)。Scope Key 可自行定义;user 和 basic 只是模板示例,并非固定字段。Key 可以增删或修改;没有授权范围时可以导出空对象。
文件末尾导出的 Scope 联合类型会根据配置对象中的 Key 自动生成。修改 Scope Key 后,还要同步修改 OAuth 客户端、升级规则,以及其他引用该授权范围的代码或数据。
Scope Key
Scope Key 是非空字符串,也是 OAuth 客户端申请授权时使用的值。建议使用稳定、便于识别的英文标识;需要显示给用户的名称应写在 name 中。
Scope 记录
每个 Scope Key 对应一条记录,格式如下:
Prop
Type
Scope 只说明访问令牌可以访问哪些数据或功能,不会自动包含用户拥有的全部角色或能力。
模板默认配置
| Scope Key | name.value | description.value | priority |
|---|---|---|---|
user | User Information | Allows accessing user information. | 2 |
basic | Basic Access | Example scope for basic product access. | 1 |
这两条记录只是格式示例。模板没有把 Scope Key 固定为 user 或 basic。