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

Deployment Support

合成クレデンシャル 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

合成クレデンシャル Vault の認証局コンテンツの保存

認証局（CA）コンテンツを合成クレデンシャル Vault に保存するには、次を実行します。

1. 取得したクライアントの 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
2. Web サイトまたは URL の CA 証明書をエクスポートします。
   エクスポートする場合は、ルート CA を選択していることを確認します。たとえば、www.google.com の CA 証明書をエクスポートする場合は、エクスポートする前に GTS Root R1 を選択します。
   
   これにより、証明書が .pem ファイルフォーマットでエクスポートされます。
3. エクスポートされた .pem ファイルのコンテンツで API モニタリングスクリプトを更新します。証明書のコンテンツの各行の末尾に \n\ デリミタを追加する必要があります。
   

   Example CA Certificate

   const assert = require("assert");
   
   const cert = '-----BEGIN CERTIFICATE-----\n\
   MIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFADBh\n\
   MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3\n\
   d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBD\n\
   QTAeFw0wNjExMTAwMDAwMDBaFw0zMTExMTAwMDAwMDBaMGExCzAJBgNVBAYTAlVT\n\
   MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j\n\
   b20xIDAeBgNVBAMTF0RpZ2lDZXJ0IEdsb2JhbCBSb290IENBMIIBIjANBgkqhkiG\n\
   9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4jvhEXLeqKTTo1eqUKKPC3eQyaKl7hLOllsB\n\
   CSDMAZOnTjC3U/dDxGkAV53ijSLdhwZAAIEJzs4bg7/fzTtxRuLWZscFs3YnFo97\n\
   nh6Vfe63SKMI2tavegw5BmV/Sl0fvBf4q77uKNd0f3p4mVmFaG5cIzJLv07A6Fpt\n\
   43C/dxC//AH2hdmoRBBYMql1GNXRor5H4idq9Joz+EkIYIvUX7Q6hL+hqkpMfT7P\n\
   T19sdl6gSzeRntwi5m3OFBqOasv+zbMUZBfHWymeMr/y7vrTC0LUq7dBMtoM1O/4\n\
   gdW7jVg/tRvoSSiicNoxBN33shbyTApOB6jtSj1etX+jkMOvJwIDAQABo2MwYTAO\n\
   BgNVHQ8BAf8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUA95QNVbR\n\
   TLtm8KPiGxvDl7I90VUwHwYDVR0jBBgwFoAUA95QNVbRTLtm8KPiGxvDl7I90VUw\n\
   DQYJKoZIhvcNAQEFBQADggEBAMucN6pIExIK+t1EnE9SsPTfrgT1eXkIoyQY/Esr\n\
   hMAtudXH/vTBH1jLuG2cenTnmCmrEbXjcKChzUyImZOMkXDiqw8cvpOp/2PV5Adg\n\
   06O/nVsJ8dWO41P0jmP6P6fbtGbfYmbW0W5BjfIttep3Sp+dWOIrWcBAI+0tKIJF\n\
   PnlUkiaY4IBIqDfv8NZ5YBberOgOzW6sRBc4L0na4UU+Krk2U886UAb3LujEV0ls\n\
   YSEY1QSteDwsOoBrp+uvFRTp2InBuThs4pFsiv9kuXclVzDAGySj4dzp30d8tbQk\n\
   CAUw7C29C79Fv1C5qfPrmAESrciIxpg0X40KPMbp1ZWVbd4=\n\
   -----END CERTIFICATE-----';
   (async () => {
   var response = await client.get("https://synthetic.api.appdynamics.com/version", {
       https: {
   		certificateAuthority: cert
   	}
   });
   assert.equal(response.statusCode, 200);
   assert.equal(response.statusMessage, "OK");
   })()

   CODE

ユーザ権限

コントローラ管理 UI では、アカウントレベルのロールとグループを設定できます。要件に基づいてユーザーにロールとグループを追加できます。Manage Credential Vault 権限により、クレデンシャル 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] で、ユーザおよび/またはグループを追加します。