5.9.1　プロキシ認証情報設定

機能

インテリジェント統合管理基盤のユーザー作成プラグインからREST APIを実行する場合の，プロキシサーバの認証情報を設定します。プロキシ認証が不要な場合は設定する必要はありません。設定した情報はインテリジェント統合管理基盤に即時反映されます。

実行権限

• JP1_Console_Admin

• JP1_Console_Operator

APIのバージョン

v1

形式

リクエスト行

POST /application/component/apiVersion/proxyUsers httpVersion

リクエストのメッセージボディー

{
    "op" : 操作内容,
    "id" : ユーザーID,
    "pw" : パスワード
}

レスポンスのメッセージボディー※

{
    "userIdList": [
        "ユーザーID",…
  ]
}

注※　opパラメーターにlistを指定した場合です。

パラメーター

op

操作内容を指定します。このパラメーターは省略できません。

• list

  インテリジェント統合管理基盤に設定されているプロキシサーバ認証情報を返却します。

• add

  インテリジェント統合管理基盤にプロキシサーバ認証情報を更新します。

• rm

  インテリジェント統合管理基盤に設定されているプロキシサーバ認証情報を削除します。

id

プロキシサーバ認証用ユーザーIDを指定します。opパラメーターに「list」を指定した場合は，指定する必要はありません。

pw

プロキシサーバ認証用ユーザーのパスワードを指定します。

opパラメーターに「list」または「rm」を指定した場合は，指定する必要はありません。

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード	メッセージ	説明
200	なし	プロキシ認証情報REST APIの処理が成功しました。
400	KAJY52012-E	プロキシ認証情報設定REST APIのパラメーターの指定が不正なため，プロキシ認証情報設定REST APIを実行できません。
403	KAJY01000-E	REST APIの実行権限がありません。
500	KAJY52013-E	プロキシ認証情報の排他に失敗しました。
	KAJY52014-E	プロキシ認証情報の設定に失敗しました。

戻り値

ステータスコードが200の場合に，レスポンスボディーに次の情報を返却します。opパラメーターの指定によって，戻り値は異なります。

• listの場合

  項番	メンバー名	データ型	説明
  1	userIdList	配列	プロキシ認証ユーザーIDの一覧

• addおよびrmの場合

  なし。

  レスポンスのメッセージボディーのサイズは0バイトです。

  戻り値	説明
  2	排他中
  3	引数不正
  7	実行権限エラー
  13	更新失敗エラー
  255	システムエラー

注意事項

このAPIを同時に実行することはできません。実行した場合エラーとなります。

使用例

プロキシ認証情報設定APIの使用例を次に示します。

リクエスト：

POST http://hostname:20703/im/api/v1/proxyUsers
{
"op":"list"
}

レスポンス：

{
  "userIdList": [
    "user001","user002",…
  ]
}

ページの先頭へ