Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

FieldType說明
policiesArray組織的全部 Policies
policies[].idStringCoop 為 Policy 建立的唯一且不可變 ID
policies[].nameString使用者為 Policy 指定的顯示名稱
policies[].parentIdString 或 null上層 Policy 的 ID,頂層 Policy 則為 null

注意事項

  • 使用 parentId 重建完整 Policy tree。parentIdnull 代表頂層 Policy,非 null 值則將子 Policy 連至上層
  • 整合應使用 Policy id,不要使用 name。名稱可從資訊儀表板變更,ID 則不可變
  • Policy 結構與用途見基本概念管理與設定