csahttpuseradd(HTTPアダプタのベーシック認証で使用するアカウント情報の登録・更新)
形式
csahttpuseradd [-h] { -userinfofile <ユーザ情報指定ファイルのパス> | -user <ユーザ名> -pass <パスワード> -uri <接続先URI> } [-r] -f <HTTPアダプタアカウント定義ファイルのパス>
機能
ベーシック認証の認証情報の作成に必要なアカウント情報を登録・更新します。アカウント情報は,ユーザ名,パスワードおよび接続先URIです。登録できるユーザ数に上限はありません。
同じユーザ名に対して異なる接続先URIを設定すれば,別のアカウント情報として管理することもできます。なお,パスワードはユーザ名と対にする必要があります。
登録または更新したアカウント情報は,HTTPアダプタの開始後から有効になります。また,HTTPアダプタが開始している状態でこのコマンドを実行すると,登録または更新したアカウント情報は,次のHTTPアダプタの開始後から有効となります。
アカウント情報管理コマンドでは,コマンド実行時に排他制御を実行しません。そのため,アカウント情報の更新中にほかにアカウント情報を更新するコマンド(csahttpuseraddコマンドまたはcsahttpuserdelコマンド)を実行した場合はエラーとなり,メッセージKDEC81216-Eを出力します。
コマンドを実行する前の注意事項を次に示します。
-
このコマンドの-passオプションにパスワードを指定した場合,プロセスの引数を確認できるOS機能などによって,パスワードが検知されるおそれがあります。このため,-userinfofileオプションを使用した,ユーザ情報指定ファイルでのパスワードの設定を推奨します。
-
コマンドを実行する管理者に限定して,HTTPアダプタアカウント定義ファイルに対する更新・参照権限を設定してください。
-
コマンドにユーザ情報指定ファイルを指定する場合,コマンドを実行する管理者に限定して,ユーザ情報指定ファイルに対する更新・参照権限を設定してください。
-
HTTPアダプタアカウント定義ファイルを更新する場合は,バックアップファイルの作成をお勧めします。
引数
-h
コマンドの使用方法が表示されます。このオプションを指定している場合は,ほかのオプションを指定しても無視されます。
-userinfofile <ユーザ情報指定ファイルのパス>
ユーザ名,パスワード,接続先URIが記載されているユーザ情報指定ファイルのパスを指定します。絶対パス,またはコマンド実行時のカレントディレクトリからの相対パスで指定してください。パスが空白を含む場合は,パス全体をダブルクォーテーション(")で囲んでください。
指定されたユーザ情報指定ファイルのユーザ情報がすべて正常であれば,その内容がHTTPアダプタアカウント定義ファイルに一括で登録または更新されます。ただし,次の場合はエラーとなり,登録・更新は実施されません。
-
指定されたファイルが存在しない場合
-
ファイル内のユーザ情報に1つでも不正があった場合
-
ファイル内にユーザ名と接続先URIの同じ組み合わせがある場合
なお,実行対象のユーザ情報指定ファイルには,ユーザ情報の登録または更新のどちらかだけを指定できます。
ユーザ情報指定ファイルの記載方法については,「6.21.1 ユーザ情報指定ファイル」を参照してください。
-user <ユーザ名> 〜<半角英数字および半角記号> ((1〜80文字))
登録または更新したいアカウント情報のユーザ名を指定します。
使用できる文字は,半角英数字,半角記号(ASCIIコードの「0x21」〜「0x7E」),および半角スペース(ASCIIコードの「0x20」)です。大文字と小文字は区別されます。使用できる半角記号を次に示します。
-
感嘆符(!)
-
ダブルクォーテーション(")
-
番号記号(#)
-
ドル記号($)
-
パーセント(%)
-
アンパサンド(&)
-
アポストロフィ(')
-
始め小括弧(()
-
終わり小括弧())
-
アスタリスク(*)
-
正符号(+)
-
コンマ(,)
-
ハイフン(-)
-
ピリオド(.)
-
スラッシュ(/)
-
コロン(:)
-
セミコロン(;)
-
左アングルブラケット(<)
-
右アングルブラケット(>)
-
等号(=)
-
クエスチョンマーク(?)
-
単価記号(@)
-
始め角括弧([)
-
終わり角括弧(])
-
円マーク(\)
-
アクサンシルコンフレックス(^)
-
アンダーバー(_)
-
アクサングラーブ(`)
-
始め波括弧({)
-
終わり波括弧(})
-
パイプライン(|)
-
波ダッシュ(~)
指定したユーザ名とHTTPアダプタアカウント定義ファイルのユーザ名が完全一致した場合,同一のユーザ名と判断されます。
-pass <パスワード> 〜<半角英数字および半角記号> ((1〜80文字))
登録または更新するアカウント情報に対応するパスワードを指定します。
使用できる文字は,半角英数字,半角記号(ASCIIコードの「0x21」〜「0x7E」),および半角スペース(ASCIIコードの「0x20」)です。大文字と小文字は区別されます。使用できる半角記号を次に示します。
-
感嘆符(!)
-
ダブルクォーテーション(")
-
番号記号(#)
-
ドル記号($)
-
パーセント(%)
-
アンパサンド(&)
-
アポストロフィ(')
-
始め小括弧(()
-
終わり小括弧())
-
アスタリスク(*)
-
正符号(+)
-
コンマ(,)
-
ハイフン(-)
-
ピリオド(.)
-
スラッシュ(/)
-
コロン(:)
-
セミコロン(;)
-
左アングルブラケット(<)
-
右アングルブラケット(>)
-
等号(=)
-
クエスチョンマーク(?)
-
単価記号(@)
-
始め角括弧([)
-
終わり角括弧(])
-
円マーク(\)
-
アクサンシルコンフレックス(^)
-
アンダーバー(_)
-
アクサングラーブ(`)
-
始め波括弧({)
-
終わり波括弧(})
-
パイプライン(|)
-
波ダッシュ(~)
-uri <接続先URI> 〜<半角英数字および半角記号>
ベーシック認証を実施するサービスのURIを指定します。アカウント情報から作成された認証情報は,ここで指定された接続先URIでベーシック認証が実施されます。
接続先URIの指定形式を次に示します。< >で囲まれた部分は要素を表し,[ ]で囲まれた部分は省略できることを表します。
<scheme>://<host>[:<port>][<path>]
ここで指定した値は,認証情報の作成時に実行されるURIのマッチングで,次のように補完または解釈されます。
-
「:<port>」を省略した場合,次に示す値で補完されます。
httpの場合:80
httpsの場合:443
-
「<path>」を省略した場合,「/」が補完されます。
-
「<scheme>」および「<host>」は,大文字と小文字は区別されません。
指定した接続先URIと,HTTPアダプタアカウント定義ファイルの接続先URIを正規化して,それらの値が完全一致した場合,同一の接続先URIと判断されます。
なお,接続先URIを更新する場合は,ユーザ名および接続先URIを指定してアカウント情報を削除し,再度登録してください。
-r
パスワードを更新する場合に,-passオプションと併せて指定します。
-f <HTTPアダプタアカウント定義ファイルのパス>
このコマンドで定義したアカウント情報を保存するための,HTTPアダプタアカウント定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は,オプション引数全体をダブルクォーテーション(")で囲んでください。
指定したファイルが存在しない場合は次のように動作します。
-
アカウント情報の登録時
指定したファイル名で,HTTPアダプタアカウント定義ファイルが新規作成されます。ただし,指定したディレクトリが存在しない場合はエラーになります。
-
アカウント情報の更新時(引数-rを指定した場合)
エラーになります。
コマンド実行後,ここで保存したHTTPアダプタアカウント定義ファイルは,HTTPアダプタ実行環境プロパティファイルのadphttp.config.account-inf-filepathプロパティに設定することで読み込まれます。HTTPアダプタ実行環境プロパティファイルについては,「6.14.2 HTTPアダプタ実行環境プロパティファイル」を参照してください。
戻り値
戻り値 |
意味 |
---|---|
0 |
正常終了しました。 |
1 |
コマンドが異常終了しました。 |
9 |
実行権限のチェックエラーが発生しました。 |
注意事項
-
HTTPアダプタアカウント定義ファイルは直接編集しないでください。