跳至主要內容
文件
文件
Peakon
上次更新時間 ：2025-01-24
概念：Peakon SCIM 2.0 API

概念：Peakon SCIM 2.0 API

Peakon 的 API 可自動執行員工配置和取消配置，確保 Peakon 調查參與與支援 SCIM 2.0 協定的系統（例如 Microsoft Azure Active Directory、Okta 和 OneLogin）保持一致。此方法允許多個系統更新和同步員工記錄。

關於 SCIM 2.0

跨域身分識別管理系統 (SCIM) 2.0 指定了一種標準化 REST 協議，用於透過 HTTP 單向配置使用者。您現有的身分識別管理系統可以設定為自動將其資料庫所做的變更同步到第三方應用程式（如 Peakon）。在 SCIM 協定中，中央身分管理系統被稱為“身分提供者”，第三方應用程式被稱為“服務提供者”。透過將 Peakon 設定為您現有身分管理系統的服務供應商，您的組織將能夠充分利用自動帳戶配置。
有關如何設定的說明，請訪問 使用 SCIM 2.0 設定員工配置。

支援的操作

Peakon SCIM 2.0 API 支援以下操作：
  • 創建用戶
  • 更新用戶
  • 刪除用戶
  • 啟用/停用用戶
  • 使用者批量操作

企業架構擴展

Peakon 支援企業用戶架構擴充中的以下基本屬性，如 SCIM 2.0 規格所定義：
  • employeeNumber
  • 部門
  • 主管
貴公司的架構包含貴公司的企業用戶架構和 Peakon 架構擴充。若要檢索貴公司支援的模式（包括可用欄位），請呼叫
取得模式
 端點。

Peakon 模式擴展

除了基本欄位外，Peakon 還提供了自訂架構擴展，以允許自訂屬性的欄位資料（例如
經理
、
出生日期
、
部門
等）。此擴充的格式遵循 SCIM 2.0 規範中指定的格式。
自訂屬性的值類型取決於屬性的類型：
屬性類型
值類型
選項類型屬性。
例如：
部門
。
字串值（最多 256 個字元）。
日期類型屬性。
例如：
出生日期
。
日期時間
 字串（ISO 8601 格式）。
數字類型屬性。
例如：
薪水
。
一個整數值。
員工類型屬性。
例如：
經理
。
包含所引用員工的電子郵件的字串值。由於員工類型屬性引用系統中的其他員工，因此引用的員工需要事先存在於系統中。您可以透過兩步驟配置來完成此操作，第一步僅包含基本字段，第二步包含擴充字段。
自訂屬性作為主要資源欄位的子物件提供。例子： 
{
“name” : {
“firstName”: “Jane”,
“lastName”: “Smith”
},
“urn:ietf:params:scim:schemas:extension:peakon:2.0:User”: {
“Business Unit”: “Engineering”,
“Department”: “IT”
}
}
若要檢索貴公司支援的模式（包括可用欄位），請呼叫
取得模式
 端點。

有效載荷

速率限制

Peakon SCIM API 的速率限制為每小時 25,000 次操作。批次 SCIM API 請求在請求負載中每個操作消耗 1 個操作。其他 SCIM API 請求消耗 1 個操作。任何整合都應限制其 API 調用，以確保不超過此限制。