能力索引
能力(capability)是這條 API 的授權單位。scope 命名空間是 lightup.<capability>,目錄是版本化的靜態清單。
目錄新增能力不會自動擴權。 租戶安裝應用時核准的是當下目錄的具體 id 集合,不是「全部」這個意圖;之後目錄多出來的能力要重新核准才會生效。
| 能力 | 資源型別 | 最低方案 | 可用狀態 | 說明 |
|---|---|---|---|---|
lightup.profile.self.read |
self | L1 | 預覽 preview |
讀這張 token 代表的 service account |
lightup.person.read |
person | L2 | 預覽 preview |
讀獲授權人員的最少欄位 |
lightup.person.metadata.read |
person | L2 | 預覽 preview |
讀本 app 自己的人員 metadata |
lightup.person.metadata.write |
person | L2 | 預覽 preview |
寫/刪本 app 自己的人員 metadata |
lightup.tenant.info.read |
tenant | L1 | 預覽 preview |
讀租戶公開識別欄位 |
可用狀態(availability)
| 狀態 | 意義 |
|---|---|
規劃 planned |
只存在於目錄,不會出現在可呼叫的路徑上 |
預覽 preview |
契約已定案、可依此開發;實作與開通尚未完成,不保證任何環境已經可呼叫 |
正式 ga |
正式支援,適用相容與棄用政策 |
狀態轉換(planned → preview → ga)不算 API 升版,但一定會如實標在這一頁與變更紀錄。
方案等級
min_plan 是這項能力需要的最低租戶方案等級(L1/L2/L3)。有效能力是四層的交集:
有效能力 = 租戶方案上限
∩ 租戶對這支應用的 grant
∩ service account/使用者當次授權
∩ 資源政策(例如「這個租戶對這個人有沒有有效關係」)
任何一層縮水,能力就縮水。方案升級不會自動放大既有 grant:升級之後仍要重新核准才拿得到新增的能力。
每項能力對應的操作
| 能力 | 操作 |
|---|---|
lightup.profile.self.read |
GET /v1/me |
lightup.person.read |
GET /v1/persons/{personId} |
lightup.person.metadata.read |
GET /v1/persons/{personId}/extensionsGET /v1/persons/{personId}/extensions/{extensionId} |
lightup.person.metadata.write |
PUT /v1/persons/{personId}/extensions/{extensionId}DELETE /v1/persons/{personId}/extensions/{extensionId} |
lightup.tenant.info.read |
GET /v1/tenant |