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。