5.14.1 シングルサインオンマッピング定義反映
- 機能
-
シングルサインオンマッピング定義ファイル(imdd_sso_mapping.properties)で定義したマッピング情報を,インテリジェント統合管理基盤に反映します。設定した情報はインテリジェント統合管理基盤に即時反映されます。
シングルサインオンマッピング定義ファイルに有効なプロパティが一つも存在しない状態で定義の反映を実行した場合はKAJY52031-Wメッセージをレスポンスに設定し,反映済みのシングルサインオンマッピング定義をクリアします。
シングルサインオンマッピング定義ファイル(imdd_sso_mapping.properties)については,「シングルサインオンマッピング定義ファイル(imdd_sso_mapping.properties)」(2. 定義ファイル)を参照してください。
- 実行権限
-
-
JP1_Console_Admin
-
JP1_Console_Operator
-
- APIのバージョン
-
v1
- 形式
-
- リクエスト行
POST /application/component/apivVersion/updateSsoMap httpVersion
- リクエストのメッセージボディー
-
なし。
- パラメーター
-
なし。
- ステータスコード
-
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード
戻り値
メッセージ
説明
200
−
なし
シングルサインオンマッピング定義反映REST APIの処理が成功しました。
KAJY52031-W
シングルサインオンマッピング定義ファイルに有効な定義がありません。
403
7
KAJY01000-E
REST APIの実行権限がありません。
500
2
KAJY52022-E
シングルサインオンマッピング定義の排他に失敗しました。
13
KAJY52023-E
シングルサインオンマッピング定義の反映に失敗しました。
14
KAJY52026-E
シングルサインオンマッピング定義ファイルが正しく読み込めませんでした。
- 戻り値
-
戻り値の説明を次に示します。
戻り値
説明
2
排他失敗
7
実行権限エラー
13
更新エラー
14
定義ファイル読み込みエラー
255
システムエラー
- 注意事項
-
-
このAPIを同時に実行することはできません。実行した場合エラーとなります。
-
APIの実行時にエラーが発生した場合,エラーメッセージを統合トレースログへ出力します。APIのエラーのレスポンスの内容にエラーメッセージを含めて呼び出し元へ返却します。呼び出し元は受け取ったレスポンスの情報を使って,呼び出し元でメッセージの表示を行います。jddupdatessomapコマンドからREST APIが呼ばれた際に,エラーのレスポンスが返却された場合は,エラーの内容を標準エラー出力に出力します。jddupdatessomapコマンドについては「jddupdatessomap」(1. コマンド)を参照してください。
-
- 使用例
-
- リクエスト:
POST http://hostname:20703/im/api/v1/updateSsoMap HTTP/1.1 Authorization: Bearer xxxx Accept-Language: ja Content-Type: application/json Accept: application/json
- 警告終了時のレスポンス:
{ "messageList": [ { "messageId": "KAJY52031-W", "message": "シングルサインオンマッピング定義ファイルに有効な定義がありません" } ] }