RESTful APIの設定

RESTful API とは、REST（REpresentational State Transfer）の原則に従って設計されたWeb APIのことを指します。RESTは、Webサービス間でデータをやり取りするためのシンプルなアーキテクチャスタイルであり、特定の技術ではなく、一連の設計指針を提供するものです。RESTful APIでは、主にHTTPプロトコルを用い、リクエスト（GET、POST、PUT、DELETEなど）を通じてリソース（データやオブジェクト）を操作します。

SeciossLink管理コンソール左メニューの「統合ID管理」–「RESTful API 設定」では、ID管理システムのID情報を、APIを経由して他のWebサービスに同期する設定を行えます。

設定を行うには、Webサービス側がRESTful APIインターフェースを標準で備えている必要があります。具体的な設定方法はWebサービス側のAPI仕様に依存しますが、この機能を使えば特別な仕組みを用意することなく、外部からHTTP（S）で操作をすることが可能です。

RESTful API設定の項目は以下の通りです。

項目名	説明
システムID※	システムを識別するIDを設定します。
URL※	システムのURLを設定します。
認証方式	認証方式を「OAuth｜Basic｜POST」から選択します。
OAuth認証
設定	認証方式でOAuthを選択した場合、リクエスト設定を、トークン取得またはアクセストークンから選択します。
Authorize URL	OAuth認証のAuthorize URLを設定します。
Token URL	OAuth認証のToken URLを設定します。
クライアントID	OAuth認証のクライアントIDを設定します。
クライアントシークレット	OAuth認証のクライアントシークレットを設定します。
アクセストークン	OAuth認証のアクセストークンを設定します。 ※固定のアクセストークンを発行するシステムの場合
Authorizationヘッダー	OAuth認証のAuthorizationヘッダをBearerまたはOAuthから選択します。
ログイン認証
ユーザー名	認証方式でBasic、POSTを選択した場合、システムに接続するユーザー名を設定します。
パスワード	認証方式でBasic、POSTを選択した場合、システムに接続するパスワードを設定します。
パラメーター	認証方式でPOSTを選択した場合、システムに送信するパラメーター名と値を設定します。パラメーターを追加する場合は「追加」ボタンをクリックしてください。
レスポンス	認証方式でPOSTを選択した場合、ログインした際のレスポンスを設定します。 エラーコードのパラメーター名：エラーコードが格納されているパラメーター名（例：code） 成功の場合のエラーコード：認証が成功した場合のエラーコードの値（例：0） セッションのパラメーター名：セッションが発行される場合のパラメーター名（例：sessid）
リクエストの形式	システムへのリクエストの形式を「JSON｜XML｜POST」から選択します。
レスポンスの形式	システムからのレスポンスの形式を「JSON｜XML｜POST」から選択します。
メソッド	追加・変更・削除・検索それぞれのリクエストのHTTPメソッドを「GET｜POST｜PUT｜DELETE」から選択できます。
ユーザー
同期の実行	同期を実行する場合には「有効」にチェックを入れます。
追加の設定	追加リクエストの設定をいます。 パス：APIのパスを設定します（“URL”の後ろに追加します）。%rは“一意な属性”で設定した属性の値に変換されます。（例：/users/%r） パラメーター名、値：リクエストに付加する固定のパラメーター名と値を設定します。（例：パラメーター名 action、値 create） 設定を追加する場合は「追加」ボタンをクリックしてください。
変更の設定	変更リクエストの設定を行います（以下、同上）。
削除の設定1	削除リクエストの設定を行います（以下、同上）。
削除の設定2	削除リクエストの設定を行います（以下、同上）。
検索の設定	検索リクエストの設定を行います（以下、同上）。 検索結果のパラメーター名：検索の場合、レスポンスの検索結果が格納されているパラメーター名を設定します。（例：entries）
同期条件	簡易フィルター：同期条件とするエントリーの条件をLDAPの検索フィルター形式で設定します。フィルターを追加する場合は「フィルター追加」ボタンをクリックしてください。 詳細フィルター：同期条件とするエントリーを直接、入力して指定します。（例：(seciossAccountStatus=active)）
IDのパラメーター名	システムのデータのIDが格納されているパラメーター名を設定します。（例：id）
一意な属性	システムのデータを一意に識別する値が格納されているSeciossLinkの属性名をLDAPの検索フィルター形式で設定します。（例：mail） 変更リクエスト：システムで一意な属性の値を変更できる場合には、変更を行うリクエストボディを設定できます。%rは変更前の値、%aは変更後の値に変換されます。（例：{“login” : ”%a”}）
属性	システムに同期する属性とパラメーター名を設定します。 SeciossLink（同期元）：属性をLDAPの検索フィルター形式で設定します。 パラメーター名：システムのパラメーター名を設定します。 属性を追加する場合は「追加」ボタンをクリックしてください。
属性（API）	システムに同期する属性と更新するAPIを設定します。 %rはデータのID、%aは属性値に変換されます。 SeciossLink（同期元）：属性（API）をLDAPの検索フィルター形式で設定します。 追加・削除・検索のパス：値を追加・削除・検索するAPIのパスを設定します（“URL”の後ろに追加します）。（例：/users/%r/email_aliases） 追加、削除、検索のリクエスト：値を追加・削除・検索するリクエストボディを設定します。（例：{“email” : “%a”}） 検索結果のパラメーター名：検索の場合、属性値が格納されているレスポンスのパラメーター名を設定します。（例：entries） 属性値のパラメーター名：属性値のパラメーター名を設定します。（例：email） IDのパラメーター名：データのIDのパラメーター名を設定します。（例：id） 属性（API）を追加する場合は「追加」ボタンをクリックしてください。
デフォルト値	システムにデータを追加する際のデフォルト値を設定します。「パラメーター名」にシステムのパラメーター名を、「値」にデフォルト値を設定してください。 「値」には、“%{関数名(引数)}”の形式で関数を実行した値を設定できます。引数にはLDIF形式の更新データを%0として使用可能です。 デフォルト値を追加する場合は「追加」ボタンをクリックしてください。
属性値変換	SeciossLinkから同期するエントリーの属性値を変換できます。 属性名：変換対象の属性名をLDAPの検索フィルター形式で設定します。（例：mail） 簡易フィルター：指定した条件に一致したユーザー、またはグループ、組織のみ自動で値を設定します。条件に設定する項目をLDAPの検索フィルター形式で指定することが可能です。フィルターを追加する場合は、「フィルター追加」ボタンをクリックしてください。 詳細フィルター：指定した条件に一致したユーザー、またはグループのみ自動で値を設定します。（例：(objectClass=inetOrgPerson)） 変換前：変換前の値を入力します。 変換後：変換後の値を入力します。 “%{関数名(引数)}”の形式で関数を実行した値を設定できます。引数にはLDIF形式の更新データを"%0"として使用可能です。 属性値変換の設定を追加する場合は「追加」ボタンをクリックしてください。画面横の「↑」「↓」ボタンで設定の順番を入れ替えることもできます。
レスポンス	システムのレスポンスを設定します。 エラーコードのパラメーター名：エラーコードが格納されているパラメーター名を設定します。（例：code） メッセージのパラメーター名：メッセージが格納されているパラメーター名を設定します。（例：message） 成功の場合のエラーコードまたはメッセージ：リクエストが成功した場合のエラーコードまたはメッセージを設定します。（例：0） 既に存在する場合のエラーコードまたはメッセージ：データが既に存在する場合のエラーコードまたはメッセージを設定します。このエラーの場合、SeciossLinkのデータでシステムのデータを上書きします。（例：68） 存在しない場合のエラーコードまたはメッセージ：データが存在しない場合のエラーコードまたはメッセージを設定します。このエラーの場合、SeciossLinkのデータでシステムにデータを追加します。（例：32）
グループ：上記「ユーザー」と同様に設定します。
組織：上記「ユーザー」と同様に設定します。

※は必須項目です。

すべての設定が完了したら、画面下部の「保存」ボタンをクリックします。