SCIM 2.0 API

OPTiM Storeでは、ライセンスの付与や変更が行われると、その都度御社サービス側に SCIM プロトコルに従ってユーザー追加・更新・削除通知が送られます。

本ドキュメントでは、この通知を受けとるための SCIM API Server を実装する上で必要な仕様を記載しています。

処理フロー

OPTiM Store からの送信されるリクエストとレスポンスのフローは以下のとおりです。

認証・認可フロー

SCIM サーバーの認証・認可では OAuth のクライアントクレデンシャルフローを使用するため、OAuth 2.0のAuthorization Serverを実装して頂く必要があります。 ライブラリをご利用頂いても問題ありません。

OAuth

• OAuth を利用するには「クライアント ID」「クライアントシークレット」が必要となります。
• OAuthではアクセストークンが有効な間、何度も SCIM サーバーにリクエストできます。アクセストークンの有効期限が切れた場合は再度アクセストークンの取得要求がリクエストされます。

API仕様

OPTiM Store から SCIM サーバーへ接続するための仕様について詳細を説明します。

OPTiM Storeとのプロビジョニングを行うにあたっては、これらのAPIを実装して頂く必要があります。

APIエンドポイント

SCIM サーバーとして実装して頂く必要があるエンドポイントについて説明します。 なお、エンドポイントまでのパスは任意で構いません。

OPTiM Store からアクセスされるエンドポイントは下表のとおりです。

リソース	エンドポイント名	行う操作	説明
利用者	/Users	GET,POST,PUT,DELETE	ユーザーの取得、作成、変更、削除を行います。
認証・認可	/token	POST	認証を行い、アクセストークンを返却します。