SeciossLink 管理者ガイド

統合ID 管理
Restful API の設定

左メニューの「統合ID管理」Restful API 設定」をクリックすると同期対象のRestful APIのシステムを登録することができます。

図 93 Restful APIの設定

項目名 説明
システムID システムを識別するID
URL システムのURL
認証方式 システムに接続する認証方式(OAuth|Basic|POST
OAuth認証 Authorize URL OAuthのAuthorize URL
OAuth認証 Token URL OAuthのToken URL
OAuth認証 クライアントID OAuthのクライアントID
OAuth認証 クライアントシークレット OAuthのクライアントシークレット
OAuth認証 アクセストークン OAuthのアクセストークン

固定のアクセストークンを発行するシステムの場合、設定して下さい。

ログイン認証 ユーザ名 認証方式BasicPOSTでシステムに接続するユーザ名

認証方式POSTの場合はPOSTするパラメータ名も設定して下さい。

ログイン認証 パスワード 認証方式BasicPOSTでシステムに接続するパスワード

認証方式POSTの場合はPOSTするパラメータ名も設定して下さい。

ログイン認証 パラメータ 認証方式POSTでシステムに送信するパラメータ名と値
ログイン認証 レスポンス 認証方式POSTでログインした際のレスポンスの形式

・エラーコードのパラメータ名:

エラーコードが格納されているパラメータ名

例:code

・成功の場合のエラーコード:

認証が成功した場合のエラーコードの値

例:0

・セッションのパラメータ名:

セッションが発行される場合のセッションのパラメータ名

例:sessid

リクエストの形式 システムへのリクエストの形式(JSON|XML|POST
レスポンスの形式 システムからのレスポンスの形式(JSON|XML|Text
メソッド 追加、変更、削除、検索リクエストのHTTPメソッド(GET|POST|PUT|DELETE
同期の実行 同期を実行するかどうか
追加、変更、削除、検索の設定 追加、変更、削除、検索リクエストの設定

・パス:

APIのパス(“URL”の後ろに追加します。)

%rは“一意な属性”で設定した属性の値に変換されます。

例:/users/%r

・パラメータ名、値:

リクエストに付加する固定のパラメータ名と値

例:パラメータ名 action、値 create

・検索結果のパラメータ名:

検索の場合、レスポンスの検索結果が格納されているパラメータ名

例:entries

同期条件 同期対象となるエントリの条件(LDAPの検索フィルタ形式)

例:(seciossAccountStatus=active)

IDのパラメータ名 システムのデータのIDが格納されているパラメータ名

例:id

一意な属性 システムのデータを一意に識別する値が格納されているSeciossLinkの属性名

例:mail

一意な属性 変更リクエスト システムで一意な属性の値を変更可能な場合、変更を行うリクエストボディの設定

%rは変更前の値、%aは変更後の値に変換されます。

例:{“login” : ”%a”}

属性 システムに同期する属性とパラメータ名

“属性名SeciossLinkの属性名、パラメータ名はシステムのパラメータ名です。

属性(API システムに同期する属性と更新するAPIの設定

%rはデータのID%aは属性値にに変換されます。

・属性名:
SeciossLink
の属性名

・追加、削除、検索のパス:

値を追加、削除、検索するAPIのパス(“URL”の後ろに追加します。)

例:/users/%r/email_aliases

・追加、削除、検索のリクエスト:

値を追加、削除、検索するリクエストボディ

例:{“email” : “%a”}

・検索結果のパラメータ名:

検索の場合、属性値が格納されているレスポンスのパラメータ名

例:entries

・属性値のパラメータ名:

属性値のパラメータ名

例:email

IDのパラメータ名:

データのIDのパラメータ名

例:id

デフォルト値 システムにデータを追加する際のデフォルト値

“パラメータ名”にシステムのパラメータ名、“値”にデフォルト値を設定して下さい。

“値”には、 “%{関数名(引数)}”の形式で関数を実行した値を設定することができます。引数にはLDIF形式の更新データを%0として使用することができます。

属性値変換 SeciossLinkから同期するエントリの属性値の変換を行うことができます。

・変換条件 属性名:

変換対象の属性名

例:mail

・変換条件 フィルタ:

変換対象となるエントリをLDAPの検索フィルタで指定

例:(objectClass=inetOrgPerson)

・変換前:

変換前の値

・変換後:

変換後の値

“変換後”には、 “%{関数名(引数)}”の形式で関数を実行した値を設定することができます。引数にはLDIF形式の更新データを%0として使用することができます。

レスポンス システムのレスポンスの設定を行います。

・エラーコードのパラメータ名:
エラーコードが格納されているパラメータ名
例:code

・メッセージのパラメータ名:
メッセージが格納されているパラメータ名
例:message

・成功の場合のエラーコードまたはメッセージ:
リクエストが成功した場合のエラーコードまたはメッセージ
例:0

・既に存在する場合のエラーコードまたはメッセージ:
データが既に存在する場合のエラーコードまたはメッセージ
このエラーの場合、SeciossLinkのデータでシステムのデータを上書きします。
例:68

・存在しない場合のエラーコードまたはメッセージ:
データが存在しない場合のエラーコードまたはメッセージ
このエラーの場合、SeciossLinkのデータでシステムにデータを追加します。
例:32

※1:ユーザ情報、グループ情報、組織情報についてそれぞれ設定を行います。

表 60 Resutful APIの設定項目

マニュアル内検索

マニュアル関連

ID管理と認証を一元管理可能なSaaS型サービス

seciossLink

お問い合わせ

お気軽にお問い合わせください。

アイコン:smartphone