跳至主要内容
文档
文档
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 2.0 API 有效负载 了解更多信息。

速率限制

Peakon SCIM API 的速率限制为每小时 25,000 次操作。批量 SCIM API 请求在请求负载中每个操作消耗 1 个操作。其他 SCIM API 请求消耗 1 个操作。任何集成都应限制其 API 调用，以确保不超过此限制。