API モニタリング用のクレデンシャル Vault

Deployment Support

クレデンシャル Vault は、合成 API モニタリングジョブに使用されるクレデンシャルを安全に保存します。合成スクリプトまたは API モニタリングスクリプトを使用してジョブを作成する場合、ユーザー名やパスワードなどのクレデンシャルを追加してアプリケーションにログインし、保存されたクレデンシャルへの参照をスクリプトに挿入できます。ジョブが実行されると、API モニタリングスクリプトはその参照を使用して、クレデンシャル Vault に保存されたクレデンシャルを取得します。

合成クレデンシャル Vault の使用方法

1. [] > [Tools] > [Manage Synthetic Credentials] に移動します。 

2. キーと値のペアのクレデンシャルを合成クレデンシャル Vault に追加します。 

3. 合成スクリプトを使用して、合成ジョブを作成します。 

4. 合成スクリプトにクレデンシャルキーを挿入します。

   

   ジョブが実行され、クレデンシャルキーに関連付けられているクレデンシャル値が取得されます。 

5. 合成ジョブが実行され、クレデンシャルキーに関連付けられているクレデンシャル値が取得されます。 

合成クレデンシャルの追加

クレデンシャル Vault では、クレデンシャルを 1 つずつ追加するか、複数のクレデンシャルをインポートできます。

構文ルール

次の表に、クレデンシャルの作成と API モニタリングスクリプトへのクレデンシャルの追加に使用するクレデンシャル構文ルールを示します。

"<%key%>"

1 つのクレデンシャルの追加

ユーザ名とパスワードの組み合わせなどのクレデンシャルの組み合わせを使用する場合は、2 つの個別のクレデンシャルを作成する必要があります。1 つはユーザ名のクレデンシャル、もう 1 つはパスワードのクレデンシャルです。

サンプル電子メールに単一のクレデンシャルを追加するには、次の手順を実行します。

1. [  ] > [Tools] > [Manage Synthetic Credentials] に移動します。

2. Add をクリックします。 

3. キーと値を入力します。構文ルールに従っていることを確認します。 

4. （オプション）関連付けられているアプリケーションを選択します。API モニタリングスクリプトでクレデンシャルを検索すると、関連するクレデンシャルが最初に推奨されます。 
   

複数のクレデンシャルのインポート

[Import ] ボタンを使用して複数のクレデンシャルを一度に追加できます。

サンプル電子メールとパスワードの複数のクレデンシャルを追加するには、次の手順を実行します。

1. [  ] > [Tools] > [Manage Synthetic Credentials] に移動します。

2. Import をクリックします。

3. クレデンシャルをコピーして貼り付けるか、1 行ずつ入力します。構文ルールに従っていることを確認します。 

• 一度にインポートできるクレデンシャルの最大数は 250 です。
• 関連付けられたアプリケーションをインポートされたクレデンシャルに追加することはできません。インポートした後に各クレデンシャルを個別に編集して、関連付けられているアプリケーションを追加する必要があります。 

email_key=user123@email.com
password_key=Password123
email_key=user456@email.com
password_key=Password456

API モニタリングスクリプトでクレデンシャルを使用する

対応するクレデンシャルキーをスクリプトに挿入することで、クレデンシャル値を取得できます。スクリプトでキーの入力を開始すると、特定のアプリケーションに関連付けられているクレデンシャルが最初に表示されます。

API モニタリングジョブを作成するには、以下の手順を実行します。

1. [User Experience > API Monitoring > Jobs > Add] に移動します。 
2. API モニタリングスクリプトを追加します。「最初のスクリプトの作成」を参照してください。

3. 構文 "<%key%>" を使用してクレデンシャルキーを入力します。

   API Monitoring Script

   var response = await client.get("https://authenticate-me-api.com", {
       headers: {
           api_token: <%api_token%>
       }
   }); 

   CODE

認証局（CA）のコンテンツを合成クレデンシャル Vault に保存できます。

CA コンテンツを合成クレデンシャル Vault に保存するには、取得したクライアントの Advanced HTTPS API を使用して、デフォルトの信頼できる CA 証明書を上書きします。

1. certificateAuthority オプションを構成します。これにより、CA 証明書の .pem ファイルの内容が certificate_authority_pem ファイルに保存されます。

2. スクリプトで次の文字列を指定します。

var response = await client.get("https://authenticate-me-api.com", {
    https: {
		certificateAuthority: %certificate_authority_pem%
	}
});

CODE

ユーザ権限

コントローラ管理 UI では、アカウントレベルのロールとグループを設定できます。要件に基づいてユーザーにロールとグループを追加できます。Manage Credential Vault 権限により、クレデンシャル Vault のアクセス制御を管理できます。

23.8 にアップグレードすると、既存の Administration, Agents, Getting Started Wizard 権限を持つすべてのロールに Manage Credential Vault 権限が自動的に追加されます。この処理の完了に 5 時間程度かかります。

管理者ユーザーにクレデンシャル Vault へのアクセスを許可しない場合は、それらのユーザーの Manage Credential Vault 権限を削除します。

23.8 にアップグレードする前	23.8 へアップグレードした後
Administration, Agents, Getting Started Wizard には、次の権限があります。 すべてのユーザの管理 クレデンシャルの追加、編集、および削除 保存されたクレデンシャルのキーおよび値の表示 ユーザー、タイムスタンプ、および関連するアプリケーション列の表示	既存の Administration, Agents, Getting Started Wizard 権限を持つすべてのロールに Manage Credential Vault 権限が自動的に追加されます。これには、次の権限があります。 すべてのユーザの管理 クレデンシャルの追加、編集、および削除 保存されたクレデンシャルのキーおよび値の表示 ユーザー、タイムスタンプ、および関連するアプリケーション列の表示 23.8 以降、ユーザーに Administration, Agents, Getting Started Wizard 権限を割り当てると、そのユーザーはデフォルトでクレデンシャル Vault にアクセスできなくなります。
View Credential Vault には、次の権限があります。 保存されたクレデンシャルのキーの表示 ユーザー、タイムスタンプ、および関連するアプリケーション列の表示	View Credential Vault には、次の権限があります。 保存されたクレデンシャルのキーの表示 ユーザー列とタイムスタンプ列の表示

Manage Credential Vault を持つロールを作成するには、次の手順を実行します。

1. > [Administration] > [Roles] に移動します。
2. [Roles] で、[Create] をクリックします。
3. ロール名を追加します。
4. [Account] で、[Add+] をクリックします。
5. 作成するロールに基づいて、次のいずれかの権限を選択します。
   • Manage Credential Vault
   • View Credential Vault
6. [User and Groups with this Role] で、ユーザおよび/またはグループを追加します。