Policies API
以程式方式取得組織已設定的 Policies。
Endpoint
GET /api/v1/policies/
驗證使用 X-API-KEY header。詳情見 API Keys 與 Authentication。
Response
{
"policies": [
{ "id": "policy-id-1", "name": "Violence", "parentId": null },
{
"id": "policy-id-2",
"name": "Graphic Violence",
"parentId": "policy-id-1"
},
{ "id": "policy-id-3", "name": "Threats", "parentId": "policy-id-1" },
{ "id": "policy-id-4", "name": "Spam", "parentId": null }
]
}
Response Fields
| Field | Type | 說明 |
|---|---|---|
policies | Array | 組織的全部 Policies |
policies[].id | String | Coop 為 Policy 建立的唯一且不可變 ID |
policies[].name | String | 使用者為 Policy 指定的顯示名稱 |
policies[].parentId | String 或 null | 上層 Policy 的 ID,頂層 Policy 則為 null |