jddsetopinfo
機能
OpenID認証連携でOpenIDプロバイダに登録したインテリジェント統合管理基盤のクライアントの情報(クライアントIDとクライアントシークレット)を,JP1/IM - Manager(インテリジェント統合管理基盤)に設定するコマンドです。
クライアントIDとクライアントシークレットは,OpenIDプロバイダに登録したインテリジェント統合管理基盤のクライアントの認証に使用する情報です。このため,JP1/IM - Manager(インテリジェント統合管理基盤)を起動する前に,このコマンドを実行しておく必要があります。
形式1
Usage: jddsetopinfo {-list|-add -provider OpenIDプロバイダ名 -id クライアントID -secret クライアントシークレット|-rm -provider OpenIDプロバイダ名} [-h 論理ホスト名]
形式2
jddsetopinfo -list [-h 論理ホスト名]
形式3
jddsetopinfo -add -provider OpenIDプロバイダ名 -id クライアントID -secret クライアントシークレット [-h 論理ホスト名]
形式4
jddsetopinfo -rm -provider OpenIDプロバイダ名 [-h 論理ホスト名]
実行権限
Windowsの場合:Administrators権限(WindowsのUAC機能が有効な場合は管理者コンソールから実行)
UNIXの場合:スーパーユーザー権限
格納先ディレクトリ
- Windowsの場合
-
Managerパス\bin\imdd\
- UNIXの場合
-
/opt/jp1imm/bin/imdd/
引数
- -list
-
インテリジェント統合管理基盤に設定されているOpenIDプロバイダのクライアント情報を取得する場合に指定します。
同時に指定できるのは,-hオプションだけです。
- -add
-
インテリジェント統合管理基盤に設定されているOpenIDプロバイダのクライアント情報を追加または更新する場合に指定します。このオプションを指定した場合,-providerオプション,-idオプションおよび-secretオプションの指定は必須です。指定しなかった場合はKAJY02011-Eのエラーメッセージが出力されます。それ以外のオプションとは,同時に指定できません。
- -rm
-
インテリジェント統合管理基盤に設定されているOpenIDプロバイダのクライアント情報を削除する場合に指定します。このオプションを指定した場合,-providerオプションの指定は必須です。指定しなかった場合はKAJY02011-Eのエラーメッセージが出力されます。
-providerオプション,-hオプション以外のオプションとは,同時に指定できません。
- -provider OpenIDプロバイダ
-
OpenIDプロバイダ名を指定します。インテリジェント統合管理基盤定義ファイル(imdd.properties)のOpenIDプロバイダの定義で設定した<OpenIDプロバイダのキー名>と同じ値を指定してください。詳細については「インテリジェント統合管理基盤定義ファイル(imdd.properties)」(2. 定義ファイル)を参照してください。
-listオプションとは,同時に指定できません。
- -id クライアントID
-
クライアントIDを指定します。指定できる文字は,利用するOpenIDプロバイダの仕様に準じます。
-listオプション,-rmオプションとは,同時に指定できません。
- -secret クライアントシークレット
-
-idオプションで指定したクライアントIDに対するクライアントシークレットを指定します。指定できる文字は,利用するOpenIDプロバイダの仕様に準じます。
-listオプション,-rmオプションとは,同時に指定できません。
- -h 論理ホスト名
-
JP1/IMをクラスタシステムで運用している場合に,論理ホスト名を指定します。このオプションを省略した場合は,環境変数JP1_HOSTNAMEに指定した論理ホスト名が仮定されます。環境変数JP1_HOSTNAMEを指定していない場合は,物理ホスト名が仮定されます。
注意事項
-
jddsetopinfoコマンドは複数を同時に実行できません。実行した場合,エラーとなります。
-
jddsetopinfoコマンドは,JP1/IM - Manager(インテリジェント統合管理基盤)を起動する前に,実行しておく必要があります。
-
JP1/IM - Manager(インテリジェント統合管理基盤)の起動中にjddsetopinfoコマンドを実行した場合,次回JP1/IM - Manager(インテリジェント統合管理基盤)を起動した際に設定を反映します。
戻り値
0 |
正常終了 |
2 |
排他失敗 |
3 |
引数不正 |
4 |
論理ホスト名が不正 |
5 |
設定に失敗 |
6 |
指定したOpenIDプロバイダのクライアント情報が存在しない |
7 |
jddsetopinfoコマンドの実行権限がない |
255 |
システムエラー |
使用例1
インテリジェント統合管理基盤に設定されているOpenIDプロバイダのクライアント情報を取得する場合の例を次に示します。
jddsetopinfo -list KAJY02009-I コマンド(jddsetopinfo)を開始しました okta:IM1210 keycloak:IM1210 KAJY02010-I コマンド(jddsetopinfo)が正常終了しました
使用例2
インテリジェント統合管理基盤に設定されているOpenIDプロバイダのクライアント情報を追加または更新する場合の例を次に示します。
jddsetopinfo -add -provider okta -id id001 -secret SECRET KAJY02009-I コマンド(jddsetopinfo)を開始しました KAJY02010-I コマンド(jddsetopinfo)が正常終了しました
登録状況を確認します。
jddsetopinfo -list KAJY02009-I コマンド(jddsetopinfo)を開始しました okta:id001 keycloak:id001 KAJY02010-I コマンド(jddsetopinfo)が正常終了しました
使用例3
インテリジェント統合管理基盤に設定されているOpenIDプロバイダのクライアント情報を削除する場合の例を次に示します。
jddsetopinfo -rm -provider okta KAJY02009-I コマンド(jddsetopinfo)を開始しました KAJY02010-I コマンド(jddsetopinfo)が正常終了しました
登録状況を確認します。
jddsetopinfo -list KAJY02009-I コマンド(jddsetopinfo)を開始しました keycloak:User2 KAJY02010-I コマンド(jddsetopinfo)が正常終了しました