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

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

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

歯車アイコン > [Tools] > [Manage Synthetic Credentials] に移動します。
キーと値のペアのクレデンシャルを合成クレデンシャル Vault に追加します。
合成スクリプトを使用して、合成ジョブを作成します。
合成スクリプトにクレデンシャルキーを挿入します。

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

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

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

構文ルール

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


エレメント	ルール
キー	1 ～ 100 文字英数字、ハイフン、および下線のみキーは、EUM アカウントごとに一意である必要があります
値	5000 文字非制御、印字可能な UTF-16 文字
クレデンシャルキー名（合成スクリプトで使用）	"<%key%>"

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

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

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

[] > [Tools] > [Manage Synthetic Credentials] に移動します。
Add をクリックします。
キーと値を入力します。構文ルールに従っていることを確認します。
（オプション）関連付けられているアプリケーションを選択します。API モニタリングスクリプトでクレデンシャルを検索すると、関連するクレデンシャルが最初に推奨されます。

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

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

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

[] > [Tools] > [Manage Synthetic Credentials] に移動します。
[Import] をクリックします。
クレデンシャルをコピーして貼り付けるか、1 行ずつ入力します。構文ルールに従っていることを確認します。

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

例

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

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

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

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

User Experience > API Monitoring > Jobs > Add に進みます。
API モニタリングスクリプトを追加します。最初のスクリプトの作成最初のスクリプトの作成
構文「<%key%>」を使用してクレデンシャルキーを入力します。
API モニタリングスクリプト
```
var response = await client.get("https://authenticate-me-api.com", {
headers: {
api_token: <%api_token%>
}
});
```

Store the Certificate Authority Content in the Synthetic Credential Vault

To store the Certificate Authority (CA) content in the Synthetic Credential Vault:

Override the default trusted CA certificate by using the Advanced HTTPS API of the got client:
1. Configure the certificateAuthority option. This stores the CA certificate .pem file contents in the certificate_authority_pem file.
2. Specify the following string in the script:
```
var response = await client.get("https://authenticate-me-api.com", {
https: {
certificateAuthority: %certificate_authority_pem%
}
});
```
Export the CA certificate of a website or URL. When you export, ensure that you select the root CA. For example, when you export the CA certificate of www.google.com, select GTS Root R1 before exporting.This exports the certificate in the .pem file format.

Update the API monitoring script with the content of the exported .pem file. You must add the \n\ delimiter at the end of each line of the certificate content:

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");
})()

ユーザ権限

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


権限	権限
Manage Credential Vault	すべてのユーザの管理クレデンシャルの追加、編集、および削除保存されたクレデンシャルのキーおよび値の表示ユーザー、タイムスタンプ、および関連するアプリケーション列の表示
View Credential Vault	保存されたクレデンシャルのキーの表示ユーザー列とタイムスタンプ列の表示
Manage Self Credential Vault	管理者がこの権限をユーザーに割り当てると、ユーザーは作成したログイン情報を追加、編集、および表示できます。管理者が Synthetic.self.credentialvault.disabled フラグを true に設定すると、ユーザーはログイン情報の値を表示できます。false に設定されている場合、[Value] 列は非表示になります。

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

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