メインコンテンツにスキップ
ドキュメント
ドキュメント
Peakon
最終更新: 2025-01-24
コンセプト: Peakon SCIM 2.0 API

コンセプト: Peakon SCIM 2.0 API

Peakon の API は従業員のプロビジョニングとプロビジョニング解除を自動化し、Microsoft Azure Active Directory、Okta、OneLogin などの SCIM 2.0 プロトコルをサポートするシステムと Peakon 調査への参加が一致するようにします。この方法により、複数のシステムで従業員レコードを更新および同期できます。

SCIM 2.0について

System for Cross-domain Identity Management (SCIM) 2.0 は、HTTP 経由のユーザーの一方向プロビジョニング用の標準化された REST プロトコルを指定します。既存の ID 管理システムは、データベースに加えられた変更を Peakon などのサードパーティ アプリケーションに自動的に同期するように構成できます。SCIM プロトコルでは、中央 ID 管理システムは「ID プロバイダー」と呼ばれ、サードパーティ アプリケーションは「サービス プロバイダー」と呼ばれます。既存の ID 管理システムで Peakon をサービス プロバイダーとして構成することで、組織は自動アカウント プロビジョニングを最大限に活用できるようになります。

サポートされている操作

Peakon SCIM 2.0 API は次の操作をサポートしています。
  • ユーザーを作成する
  • ユーザーを更新する
  • ユーザーを削除する
  • ユーザーの有効化/無効化
  • ユーザー向け一括操作

エンタープライズスキーマ拡張

Peakon は、SCIM 2.0 仕様で定義されているエンタープライズ ユーザー スキーマ拡張の次の基本属性をサポートしています。
  • employeeNumber
  • 部門
  • マネージャ
会社のスキーマには、会社のエンタープライズ ユーザー スキーマと Peakon スキーマ拡張が含まれています。使用可能なフィールドを含む、会社でサポートされているスキーマを取得するには、
Get schemas
 エンドポイントを呼び出します。

Peakon スキーマ拡張

Peakon は、基本フィールドに加えて、カスタム属性 (例:
Manager
、
Date of Birth
、
Department
など) のフィールド データを許可するカスタム スキーマ拡張を提供します。この拡張機能の形式は、SCIM 2.0 仕様で指定された形式に従います。
カスタム属性の値の型は、属性の型によって異なります。
属性タイプ
値の型
オプション タイプの属性。
例:
部門
。
文字列値 (最大 256 文字)。
日付型の属性。
例:
生年月日
。
DateTime
 文字列 (ISO 8601 形式)。
数値型の属性。
例:
給与
。
整数値。
従業員タイプ属性。
例:
マネージャー
。
参照先の従業員の電子メールを含む文字列値。従業員タイプ属性はシステム内の他の従業員を参照するため、参照される従業員は事前にシステム内に存在している必要があります。これは、最初のステップで基本フィールドのみを含め、2 番目のステップで拡張フィールドを含める 2 段階のプロビジョニングで実行できます。
カスタム属性は、メイン リソース フィールドのサブオブジェクトとして提供されます。例： 
{
“name” : {
“firstName”: “Jane”,
“lastName”: “Smith”
},
“urn:ietf:params:scim:schemas:extension:peakon:2.0:User”: {
“Business Unit”: “Engineering”,
“Department”: “IT”
}
}
使用可能なフィールドを含む、会社でサポートされているスキーマを取得するには、
Get schemas
 エンドポイントを呼び出します。

ペイロード

訪問 参考: Peakon SCIM 2.0 API ペイロード 詳細についてはこちらをご覧ください。

レート制限

Peakon SCIM API のレートは 25,000 操作/時間に制限されています。バルク SCIM API リクエストでは、リクエスト ペイロード内の操作ごとに 1 つの操作が消費されます。その他の SCIM API リクエストは 1 つの操作を消費します。どの統合でも、この制限を超えないように API 呼び出しを調整する必要があります。