PasswordManager CSVフォーマット
OneGateの利用者をインポート/エクスポート機能で登録する場合、以下のフォーマット・パラメーターに従ってCSVファイルを作成します。
PasswordManagerにアプリや代理入力値、Windowsサイン情報をインポート/エクスポート機能で登録する場合、以下のフォーマット・パラメーターに従ってCSVファイルを作成します。
フォーマット
CSVファイルのフォーマット(作成ルール)は以下のとおりです。
|
ファイルフォーマット |
|
|---|---|
|
CSVフォーマット |
|
パラメーター
PasswordManagerに登録するアプリ情報、代理入力値、Windowsサインイン情報のCSVファイルのパラメーター値は以下のとおりです。
PasswordManagerに登録する各アプリのCSVファイルについては、それぞれアプリ設定とユーザー設定に分類されます。
ヘッダー(見出し)ごとのパラメーター(入力値)を確認してください。
WebアプリCSV
|
列名 |
項目 |
説明 |
|---|---|---|
|
host<必須> |
ホスト名(変更不可) |
シングルサインオンURLのホスト名(型:文字列)
設定可能範囲:1〜256文字 RFC 3987に準拠した書式で指定する必要があります。ただし、シングルクォーテーション(')とカンマ(,)は利用できません。
ポートにhttpデフォルトポート(80)以外を指定した場合のスキームは「https」となります。この場合、ホスト名にスキームを指定します。 ※追加・変更・削除時必須(登録内容は変更不可) |
|
port<必須> |
ポート番号(変更不可) |
シングルサインオンURLのポート番号(型:数値) 設定可能範囲:0~65535 httpとhttpsの両方を利用する場合は「0」を指定します。空の場合は「0」として扱われます。 ※追加・変更・削除時必須(登録内容は変更不可) |
|
path<必須> |
パス(変更不可) |
シングルサインオンURLのパス(型:文字列)
設定可能範囲:0〜512文字 ※追加・変更・削除時の必須項目(登録内容は変更不可) |
|
name |
名前 |
シングルサインオンサイトの任意の名前(型:文字列)
設定可能範囲:0〜64文字 |
|
description |
説明 |
シングルサインオンサイトの任意の説明(型:文字列) 設定可能範囲:0〜256文字 |
|
is form always |
常にWebシングルサインオンを行う |
常にシングルサインオンを行う場合、任意に指定(型:数値(Bool))
0:繰り返してシングルサインオンを行わない キーが同じデータを複数インポートする場合は、それぞれ同じ値を設定します。 |
|
option flags |
特殊な自動入力動作 |
特殊な自動入力動作を行う場合、任意に指定(型:数値)
0x00(0):特殊な動作はなし 例:「160」を設定することで「同じ名前の属性が複数存在する場合にすべて入力」「入力イベントを発生」となります。 |
|
favicon |
ファビコンデータ |
アプリのファビコン画像(型:文字列) 画像データをBase64エンコードして文字列化したデータを指定します。 設定可能範囲:1~1048576文字(約1MB) |
|
param_type<必須> |
パラメーター型(変更不可) |
シングルサインオンのパラメーター型(型:文字列(定義値)
Basic-ID:基本認証のユーザー名 ※追加・変更・削除時必須(登録内容は変更不可) |
|
param_name<必須> |
パラメーター名(変更不可) |
シングルサインオンのパラメーター名(型:文字列) 設定可能範囲は、1〜256文字です。(設定内で一意となるように任意の値を設定してください) ※追加・変更・削除時必須(登録内容は変更不可) |
|
param_action_type |
自動入力のアクションタイプ |
自動入力のアクションタイプ(型:数値)
0:入力フィールド |
|
param_button_type |
ボタンタイプ |
param_action_type=0の場合のボタンタイプ(型:数値)
0:INPUTタグのbuttonタイプ 1~4を指定した場合はWebサイトを自動解析して動作しますが、正確に動作させるために「5(CSSセレクター)」の設定を任意に指定します。 |
|
param_value_type |
パラメータータイプ |
パラメーターの型(型:文字列(定義値))
username:ユーザー名として利用されます |
|
is_encrypted<必須> |
暗号化(変更不可) |
データの暗号化の可否(型:数値(Bool))
0:暗号化しない ※追加・変更・削除時必須(登録内容は変更不可) |
|
is_enabled<必須> |
シングルサインオンの有効化 |
シングルサインオン設定の有効/無効(型:数値(Bool))
0:パラメーター無効 シングルサインオン設定のパラメーターそれぞれで同じ値を設定します。 シングルサインオン設定ですべてのパラメーターが有効となった場合に、シングルサインオンが実行されます。 ※追加・変更時必須 |
|
is_default_used<必須> |
既定値の利用可否 |
既定値の利用の可否(型:数値(Bool))
0:既定値を利用しない 既定値を利用すると全ユーザーで共通の値を設定できます。 ※追加・変更時必須 |
|
user_config_mode<必須> |
ユーザー設定ページによる編集可否 |
ユーザーによるパラメーターの編集権限(型:文字列)
editable :ユーザーに表示を行い、変更を許可します。 ※追加・変更時必須 |
|
user_display_priority |
ユーザー設定ページでの表示優先度 |
シングルサインオンパラメーターの動作優先度(型:数値) 設定可能範囲:0(低い)~2147483647(高い)
優先度の高いパラメーターから順にシングルサインオンが実行されます。 |
|
param_label |
パラメーター表示名 |
シングルサインオンパラメーターの表示名(型:文字列) 設定可能範囲:0〜256文字 |
|
param_submit_selector |
ボタンアクション時のCSSセレクター |
ボタンアクション時にCSSセレクターを選択した場合(param_button_type=5)に任意に指定(型:文字列)
設定可能範囲:0〜256文字 |
|
param_action_interval |
アクションを行うまでのインターバル[ミリ秒] |
次のアクションを行うまでのインターバル(型:数値) 設定可能範囲:0~99,999(ミリ秒) |
|
encrypted_default_value |
既定値(暗号入力) |
シングルサインオンパラメーターの既定値(暗号入力)(型:文字列) エクスポート時と同じ値を再利用する場合に指定します。
既定値を設定する場合、「encrypted_default_value」列、または「plain_default_value」列のどちらかの値を設定する必要があります。 |
|
plain_default_value |
既定値(テキスト入力) |
シングルサインオンパラメーターの既定値(型:文字列) 設定可能範囲:1〜256文字
以下の値を設定することでOneGateユーザーの情報を利用できます。 空の既定値を設定する場合、ダブルクォーテーションで囲んだ空データ("")を指定します。 ダブルクォーテーションで囲わない空データはNULLデータとして扱われ、「encrypted_default_value」列の値が適用されます。 |
|
param_value_template |
代理入力既定値 |
代理入力既定値の名称(型:文字列) 設定可能範囲:0〜256文字 値を指定した場合、encrypted_value,plain_valueの値よりも優先されます。 |
|
last_update |
最終更新日時 |
最終更新日時をYYYY/MM/DD hh:mm:ss.ddd+zzzz形式(ローカル時間)で出力します。 インポートでは利用しません。 |
Webアプリユーザー設定CSV
|
列名 |
項目 |
説明 |
|---|---|---|
|
user_name<必須> |
OneGateユーザー名 |
シングルサインオンパラメーター(OneGateユーザー名)(型:文字列) 設定可能範囲:1~200文字 スペースだけで構成されるユーザー名は指定できません。 ※追加・変更・削除時必須(変更不可) |
|
user_fullname ※ |
ユーザー表示名 |
エクスポートを行った場合に、シングルサインオンパラメーターが設定されたユーザーの表示名が出力されます。 |
|
host<必須> |
ホスト名 |
シングルサインオンURLのホスト名(型:文字列) 設定可能範囲:1〜256文字 RFC 3987に準拠した書式で指定しますが、シングルクォーテーション(')とカンマ(,)は利用できません。
文字数はpunycodeエンコード後の長さで比較されます。 ※追加・変更・削除時必須(変更不可) |
|
port<必須> |
ポート番号 |
シングルサインオンURLのポート番号(型:数値)
設定可能範囲:0~65535 ※追加・変更・削除時必須(変更不可) |
|
path<必須> |
パス |
シングルサインオンURLのパス(型:文字列) 設定可能範囲:0〜512文字 文字数はURLエンコード後の長さで比較されます。 ※追加・変更・削除時必須(変更不可) |
|
param_type<必須> |
パラメーター型 |
シングルサインオンのパラメーター型(型:文字列(定義値))
Basic-ID:基本認証のユーザー名 ※追加・変更・削除時必須(変更不可) |
|
param_name<必須> |
パラメーター名 |
シングルサインオンのパラメーター名(型:文字列) ※追加・変更・削除時必須(変更不可) |
|
param_set_name |
複数パラメーター設定時の識別名 |
1ユーザーに対して複数のパラメーターの組み合わせを設定する場合に指定(型:文字列) 設定可能範囲:1〜256文字
指定しない場合は、"Default"が適用されます。 |
|
is_encrypted |
暗号化 |
暗号化の有無(型:数値(Bool))
0:暗号化しない
エクスポートを行った場合に、データの暗号化の可否が出力されます。 |
|
param_description |
パラメーターの説明 |
シングルサインオンパラメーターの説明(型:文字列) インポートでは利用しません。 |
|
encrypted_value<必須> |
パラメーターの値(暗号入力) |
シングルサインオンパラメーターの値(暗号入力)(型:文字列) エクスポート時と同じ値を再利用する場合に指定します。
パラメーターの値を設定する場合、「param.encrypted_value」列、または「param.plain_value」列のどちらかの値を設定する必要があります。 ※追加時必須 |
|
plain_value<必須> |
パラメーターの値(テキスト入力) |
シングルサインオンパラメーターの値(テキスト入力)を指定します。(型:文字列 設定可能範囲:1〜256文字
以下の値を設定することでOneGateユーザーの情報を利用できます。
空の値を設定する場合、ダブルクォーテーションで囲んだ空データ("")を指定します。 ※追加時必須 |
|
param.value_template |
代理入力既定値 |
代理入力既定値の名称(型:文字列) 設定可能範囲:0〜256文字 値を指定した場合、encrypted_param.value,plain_valueの値よりも優先されます。 |
|
last_update |
最終更新日 |
エクスポートを行った場合に、最終更新日時をYYYY/MM/DD hh:mm:ss.ddd+zzzz形式(ローカル時間)で出力します。 |
Windowsアプリ/モバイルアプリCSV
|
列名 |
項目 |
説明 |
|---|---|---|
|
name<必須> |
シングルサインオン名(変更不可) |
シングルサインオン名(型:文字列
設定可能範囲:1~64文字 ※追加・変更・削除時必須(変更不可) |
|
description |
説明 |
シングルサインオンアプリケーションの説明(型:文字列) 設定可能範囲:0〜256文字 |
|
is_enabled<必須> |
シングルサインオンの有効化 |
シングルサインオン設定の有効・無効(型:数値(Bool))
0:無効 ※追加・変更時必須 |
|
type<必須> |
アプリケーションのタイプ |
シングルサインオンを行うアプリケーションの種類(型:数値)
0:Windowsアプリケーション ※追加・変更時必須 |
|
title<必須> |
ウィンドウタイトル |
Windowsアプリの場合、シングルサインオンを行うアプリケーションのウィンドウタイトル(型:文字列) 設定可能範囲:0~64文字 ※追加・変更時必須 ※タイトルを省略した場合、プロセス名の指定が必須になります。 |
|
subtitle<必須> |
ウィンドウサブタイトル |
アプリケーションの種類(type列)がWindowsセキュリティダイアログ、またはUIオートメーションの場合に、Windowを特定するための追加タイトル(型:文字列) 設定可能範囲:0~64文字 ※追加・変更時必須 |
|
condition<必須> |
検索条件 |
Windowsアプリの「ウィンドウタイトル」と「サブタイトル」を比較する検索条件(型:数値)
0:先頭一致 ※追加・変更時必須 |
|
process_name |
プロセス名 |
対象アプリケーションを特定するためのプロセス名 設定可能範囲:0~256文字
※途中のパス指定はできません。 |
|
favicon |
ファビコンデータ |
Agent画面でシングルサインオンデータを選択する場合に表示するファビコン画像(型:数値) 画像データをBase64エンコードして文字列化したデータを指定します。 設定可能範囲:1~1048576文字(約1MB) |
|
param.index<必須> |
パラメーターのインデックス(変更不可) |
パラメーターのインデックス(型:数値) 設定可能範囲:0~4 1つのアプリ設定につき最大5個のパラメーターを登録できます。インデックスの小さい値から順番に処理が行われます。 追加/変更/削除時の必須項目です(登録内容は変更不可)。 |
|
param.description<必須> |
パラメーターの説明 |
パラメーターの説明(型:文字列) 設定可能範囲:0~256文字 ※追加・変更時必須 |
|
param.control_id<必須> |
コントロールID |
WindowsアプリのコントロールID(型:数値) 設定可能範囲:0~2147483647 ※追加・変更時必須 |
|
param.target<必須> |
対象 |
Windowsアプリがセキュリティダイアログ、またはUIオートメーションの場合の対象(型:文字列) 設定可能範囲:1~64文字 ※追加・変更時必須 |
|
param.next_action |
入力後の動作 |
Windowsアプリでの入力後の動作(型:数値)
0:何もしない
アプリケーションの種類(type列)によって指定できる値が異なります。 ※追加・変更時必須 |
|
param.next_interval |
入力後の動作を行うまでのインターバル |
Windowsアプリでの入力後の動作を行うまでのインターバル(型:数値) 設定可能範囲:0~9,999(ミリ秒) ※追加・変更時必須 |
|
param.edit_type<必須> |
ユーザーによるパラメーターの変更権限 |
ユーザーによるパラメーターの編集権限(型:文字列)
1:パラメーター変更可。ユーザーはパラメーターの値の変更・閲覧ができます。 ※すべてのパラメーターが「パラメーター変更不可(表示しない)」に設定されている場合、PasswordManager Agentの設定ツールに、パネルが表示されません。 ※追加・変更時必須 |
|
param.value_type |
パラメータータイプ |
パラメーターの型(型:文字列(定義値))
username:ユーザー名として利用されます。 |
|
param.is_encrypted<必須> |
暗号化(変更不可) |
パラメーターの暗号化の可否(型:数値(Bool))
0:暗号化しない ※追加・変更時必須(変更不可) |
|
param.is_default_used<必須> |
既定値の利用可否 |
既定値の利用の可否(型:数値(Bool)) 既定値を利用すると全ユーザーで共通の値を設定できます。 ※追加・変更時必須 |
|
param.encrypted |
既定値(暗号入力) |
シングルサインオンパラメーターの既定値(暗号入力)(型:文字列) エクスポート時と同じ値を再利用する場合に指定します。
既定値を設定する場合、「param.encrypted_default_value」列、または「param.plain_default_value」列のどちらかの値を設定する必要があります。 |
|
param.plain_default |
既定値(テキスト入力) |
シングルサインオンパラメーターの既定値(型:文字列)
ログイン名: <%ONEGATE_USER_NAME%> 設定可能範囲:1〜256文字
空の既定値を設定する場合、ダブルクォーテーションで囲んだ空データ("")を指定します。 |
|
param.value_template |
代理入力既定値 |
代理入力既定値(型:文字列) 設定可能範囲:0〜256文字
値を指定した場合、 |
|
param.autofill_type |
動作方式 |
パラメーターの動作方式(型:文字列(定義値))
「wait」を指定すると、待機動作を行います。 |
|
last_update |
最終更新日時 |
エクスポートを行った場合に、最終更新日時をYYYY/MM/DD hh:mm:ss.ddd+zzzz形式(ローカル時間)で出力します。インポートでは利用しません。 |
Windowsアプリ/モバイルアプリユーザー設定CSV
|
列名 |
項目 |
説明 |
|---|---|---|
|
user_name<必須> |
OneGateユーザー名 |
OneGateユーザー名(型:文字列) 設定可能範囲:1~200文字 スペースだけで構成されるユーザー名は指定できません。 ※追加・変更・削除時必須 |
|
user_fullname |
ユーザー表示名 |
ユーザーの表示名 インポートでは利用しません。 |
|
app_sso_name<必須> |
シングルサインオン名 |
代理入力対象のシングルサインオン名(型:文字列) 設定可能範囲:1~64文字 スペースだけで構成されるシングルサインオン名は指定できません。 ※追加・変更・削除時必須 |
|
param.index<必須> |
パラメーターのインデックス |
代理入力対象のパラメーターのインデックス(型:数値) 設定可能範囲:0~4 ※追加・変更・削除時必須 |
|
param.description |
パラメーターの説明 |
エクスポート用パラメーターの説明(型:文字列) |
|
param.is_encrypted |
暗号化 |
エクスポート用パラメーターの暗号化の有無
0:暗号化しない |
|
param.encrypted |
パラメーターの値(暗号入力) |
シングルサインオンパラメーターの値(暗号入力)(型:文字列)
パラメーターの値を設定する場合、「param.encrypted_value」列、または「param.plain_value」列のどちらかの値を設定する必要があります。 エクスポート時と同じ値を再利用する場合に指定します。 ※追加時必須 |
|
param.plain_value<必須> |
パラメーターの値(テキスト入力) |
シングルサインオンパラメーターの値(テキスト入力)を指定します。(型:文字列)
ログイン名: <%ONEGATE_USER_NAME%> 設定可能範囲:0~256文字
空の既定値を設定する場合、ダブルクォーテーションで囲んだ空データ("")を指定します。 ※追加時必須 |
|
param.value_template |
代理入力既定値 |
代理入力既定値の任意の名称(型:文字列) 設定可能範囲:0〜256文字 値を指定した場合、「param.encrypted_param.value,plain_value」の値よりも優先されます。 |
|
last_update |
最終更新日 |
最終更新日時をYYYY/MM/DD hh:mm:ss.ddd+zzzz形式(ローカル時間)で出力します。 インポートでは利用しません。 |
WindowsサインインCSV
|
列名 |
項目 |
説明 |
|---|---|---|
|
user_name<必須> |
OneGateユーザー名 |
OneGateユーザー名(型:文字列) 設定可能範囲:1~200文字 スペースだけで構成されるユーザー名は指定できません。 ※追加・変更・削除時必須 |
|
win_user_nam<必須> |
Windowsサインインユーザー名 |
Windowsにサインインするユーザー名を指定します。(型:文字列)
ログイン名: <%ONEGATE_USER_NAME%> 設定可能範囲:1~128文字 スペースだけで構成されるユーザー名は指定できません。 特定のユーザー情報として利用されます。上記の値を設定することでOneGateユーザーの情報を利用できます。 ※追加・変更・削除時必須 |
|
win_encrypted |
Windowsサインインパスワード(暗号入力) |
Windowsにサインインするユーザーのパスワード(暗号化)(型:文字列) エクスポート時と同じ値を再利用する場合に指定します。
パラメーターの値を設定する場合、 ※追加・変更時必須 |
|
win_plain_password<必須> |
Windowsサインインパスワード(テキスト入力) |
Windowsにサインインするユーザーのパスワード(型:文字列)
ログイン名: <%ONEGATE_USER_NAME%> 設定可能範囲:1~128文字
空の値を設定する場合、ダブルクォーテーションで囲んだ空データ("")を指定します。 ※追加・変更時必須 |
|
is_password_change |
Windowsサインイン時にパスワードを設定 |
Windowsサインイン時のパスワードの有無(型:数値(Bool))
0:パスワードの設定を要求しない ※追加・変更時必須 |
|
last_update |
最終更新日時 |
最終更新日時をYYYY/MM/DD hh:mm:ss.ddd+zzzz形式(ローカル時間)で出力します。インポートでは利用しません。 |