Versions Compared

    Key

    • This line was added.
    • This line was removed.
    • Formatting was changed.
    Comment: Published by Scroll Versions from this space and version 20.7
    sv-translation
    languageen

    The Synthetic Credential Vault securely stores credentials used for synthetic jobs. When you create a synthetic job with a synthetic script, you can retrieve a stored key/value credential pair, like a username and password, and inject the credential into a synthetic script. Then when the synthetic job runs, the synthetic script executes and retrieves the credentials stored in the Synthetic Credential Vault.

    To access the Synthetic Credential Vault in the Controller, go to Gear Icon Tools > Manage Synthetic Credentials. 

    Overview of Synthetic Credentials

    A synthetic credential is a key-value pair stored in the Synthetic Credential Vault. If you want to use a combination of credentials, such as a username-password combination, you must create two separate credentials: one credential for the username and another credential for the password.

    Support

    This table describes the requirements and limitations of the Synthetic Credential Vault. 

    TypeSpecification

    Deployment

    Only available for SaaS customers.

    Accounts

    Limited to 1000 credentials per EUM account.

    Synthetic jobs

    Limited to 100 credentials per synthetic job.

    Credential versions

    Past versions of credentials are not stored. Once you update a credential, you cannot retrieve the previous version.

    Manage Users

    The table below describes permission differences between admin and read-only users. See Roles and Permissions for more information.

    User LevelPermission
    Admin (requires Administration, Agents, Getting Started Wizard permissions)
    • Manage all users
    • Add, edit, and delete credentials.
    • View both keys and values of stored credentials.
    • View users, timestamps, and associated applications
    Read-only
    • View keys of stored credentials
    • View users, timestamps, and associated applications

    In the Controller UI, you can configure roles, users, and groups with Account-level, read-only permission for the Synthetic Credential Vault. AppDynamics recommends you add a read-only role and assign that role to multiple users and/or groups. 

    To create a role in the Controller UI with read-only permission:

    1. In the Controller UI, go to the gear icon > Administration > Roles.
    2. Under Roles, click Create.
    3. Add a role name, such as "Synthetic Credential Vault (read-only)."
    4. Under Account, click Add+.
    5. Check the "View Synthetic Credential Vault" box.
    6. Under User and Groups within this Role, add users and/or groups.
    Info

    To configure custom roles or users via REST API, see RBAC API.

    Anchor
    How it works
    How it works
    How to Use

    You can use the Synthetic Credential Vault in the following way: 

    1. Add a credential in key-value pair to the Synthetic Credential Vault. 
    2. Create a synthetic job that is using a synthetic script. 
    3. Inject the credential key into the appropriate place in your synthetic script. See the example from Use Synthetic Credentials in a Synthetic Script.
    4. The synthetic job will run and retrieve the credential value associated with the stored credential key. 

    Anchor
    syntax
    syntax
    Syntax Rules

    This table describes credential syntax rules for the Synthetic Credential Vault and synthetic scripts. 


    Keys

    • 1-100 characters

    • Alphanumeric characters, hyphens, and underscores only

    • Keys must be unique per EUM account

    Values

    • 1-350 characters

    • Any non-control, printable UTF-16 characters

    Credential placeholder (used in synthetic scripts)
    "<%key%>"

    Anchor
    Create a Credential
    Create a Credential
    Create Credentials

    In the Synthetic Credential Vault, you can add a single or multiple credentials.

    Anchor
    Add a single credential
    Add a single credential
    Add a single credential

    These instructions demonstrate how to add a single credential for a sample email and password.

    1. Go to Gear Icon Tools > Manage Synthetic Credentials.

    2. Click Add. 

    3. Enter a key and value. See Syntax Rules

    4. (Optional) Select an associated application. When you search for credentials in the synthetic script, associated credentials are suggested first. 

    Anchor
    Import multiple credentials
    Import multiple credentials
    Add multiple credentials

    You can add multiple credentials at once using the Import button. Make sure the imported credentials follow Syntax Rules.

    These instructions demonstrate how to add a single credential for a sample email and password. 

    1. Go to Gear Icon Tools > Manage Synthetic Credentials.

    2. Click Import.

    3. Copy and paste credentials or type them line by line. The maximum number of credentials that can be imported at once is 250.

    Note: The associated application option is not available for bulk import. You must edit each credential individually to specify the associated application. 

    Code Block
    titleExample
    linenumberstrue
    email_key=user123@email.com
    password_key=Password123

    Anchor
    Manage Credentials
    Manage Credentials
    Manage Credentials

    In the Synthetic Credential Vault, you can edit, delete, sort and search credentials.

    Edit Credentials

    With admin-level access, you can edit the associated application for existing and imported credentials. However, you can only edit one credential at a time. 

    Delete Credentials

    With admin-level access, you can remove one or more credentials at a time.

    Sort Credentials

    You can sort credentials alphabetically by clicking on the key name, user, and timestamp columns. 

    Search Credentials

    You can search credentials by key name, user, and application. 

    Anchor
    use credentials
    use credentials
    Use Credentials in a Synthetic Script

    You can retrieve credentials stored in the Synthetic Credential Vault with a synthetic script. Credentials associated to a specific application appear first when you start typing the key. 

    1. To create a synthetic job in the Controller UI, go to User Experience > Jobs > Add
    2. Add your synthetic script. See Write Your First Script for more information.
    3. Locate the DOM element.

    4. Enter the corresponding credential using the syntax "<%key%>".

      Code Block
      titleSynthetic Script
      driver.find_element_by_id("email").send_keys("<%email_key%>")
      driver.find_element_by_id("pass").send_keys("<%password_key%>")
    sv-translation
    languageja
    Appd tocbox
    Width325px

    このページの内容:

    Table of Contents
    maxLevel2

    合成クレデンシャル Vault は、合成ジョブに使用されるクレデンシャルを安全に保存します。合成スクリプトを使用して合成ジョブを作成すると、保存されたキーと値のクレデンシャルのペア(ユーザ名とパスワードなど)を取得し、そのクレデンシャルを合成スクリプトに挿入できます。次に、合成ジョブが実行されると、合成スクリプトが実行され、合成クレデンシャル Vault に保存されたクレデンシャルが取得されます。

    コントローラで合成クレデンシャル Vault にアクセスするには、[gear icon](> [Tools] > [Manage Synthetic Credentials] に移動します。 

    合成クレデンシャルの概要

    合成クレデンシャルは、合成クレデンシャル Vault に格納されているキーと値のペアとして定義されます。ユーザ名とパスワードの組み合わせなどのクレデンシャルの組み合わせを使用する場合は、2 つの個別のクレデンシャルを作成する必要があります。1 つはユーザ名のクレデンシャル、もう 1 つはパスワードのクレデンシャルです。

    Anchor
    [Restrictions(機能制限)]
    [Restrictions(機能制限)]
    サポート

    次の表では、合成クレデンシャル Vault の要件と制限事項について説明します。 

    タイプ仕様

    導入

    SaaS のお客様のみが使用できます。

    [アカウント(Accounts)]

    EUM アカウントごとに 1000 個のクレデンシャルに制限されます。

    合成ジョブ

    合成ジョブごとに 100 個のクレデンシャルに制限されます。

    クレデンシャルのバージョン

    以前のバージョンのクレデンシャルは保存されません。クレデンシャルを更新すると、以前のバージョンを取得できなくなります。

    ユーザレベルのアクセス

    すべてのユーザは、キー、ユーザ、タイムスタンプ、および関連付けられているアプリケーションを表示できます。

    管理者レベルのユーザのみが次のことを実行できます。

    • コントローラ UI の非表示/表示の値を切り替える。
    • クレデンシャルを追加、編集、および削除する。

     

    Anchor
    仕組み
    仕組み
    使用方法

    合成クレデンシャルの Vault は次の方法で使用できます。

    1. キーと値のペアのクレデンシャルを合成クレデンシャル Vault に追加します。 
    2. 合成スクリプトを使用して、合成ジョブを作成します。 
    3. 合成スクリプト内の適切な場所にクレデンシャルキーを挿入します。「合成スクリプトでの合成クレデンシャルの使用」の例を参照してください。
    4. 合成ジョブが実行され、保存されたクレデンシャルキーに関連付けられているクレデンシャル値が取得されます。 

    Anchor
    構文
    構文
    構文ルール

    次の表では、合成クレデンシャル Vault および合成スクリプトのクレデンシャル構文ルールについて説明します。 

     

    Keys

    • 1 ~ 100 文字

    • 英数字、ハイフン、および下線のみ。

    • キーは、EUM アカウントごとに一意である必要があります。

    • 1 ~ 350 文字

    • 非制御、印字可能な UTF-16 文字

    クレデンシャル プレースホルダ(合成スクリプトで使用)
    "<%key%>"

     

    Anchor
    クレデンシャルの作成
    クレデンシャルの作成
    クレデンシャルの作成

    合成クレデンシャルの Vault では、1 つまたは複数のクレデンシャルを追加できます。

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

    次の手順では、サンプルの電子メールとパスワードに対して 1 つのクレデンシャルを追加する方法について説明します。

    1. [gear icon]()> [Tools] > [Manage] に移動しますSynthetic Credential.

    2. [追加(Add)] をクリックします。 

    3. キーと値を入力します。「構文ルール」を参照してください。 

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

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

    [Import ] ボタンを使用して複数のクレデンシャルを一度に追加できます。インポートされたクレデンシャルが構文ルールに従っていることを確認してください。

    次の手順では、サンプルの電子メールとパスワードに対して 1 つのクレデンシャルを追加する方法について説明します。 

    1. [the gear icon ]()> [Tools] > [Manage] に移動しますSynthetic Credentials.

    2.  Import.

    3. クレデンシャルをコピーして貼り付けるか、1 行ずつ入力します。一度にインポートできるクレデンシャルの最大数は 250 です。

    注:関連するアプリケーションオプションは、一括インポートには使用できません。各クレデンシャルを個別に編集して、関連付けられているアプリケーションを指定する必要があります。 

    Code Block
    titleExample
    linenumberstrue
    email_key=user123@email.com
    password_key=Password123

    Anchor
    クレデンシャルの管理
    クレデンシャルの管理
    クレデンシャルの管理

    合成クレデンシャルの Vault では、クレデンシャルを編集、削除、ソート、および検索することができます。

    クレデンシャルの編集

    管理者レベルのアクセス権を使用すると、既存のクレデンシャルとインポートされたクレデンシャルに関連するアプリケーションを編集できます。ただし、一度に編集できるクレデンシャルは 1 つだけです。 

    クレデンシャルの削除

    管理者レベルのアクセス権を使用すると、一度に 1 つ以上のクレデンシャルを削除できます。

    クレデンシャルのソート

    クレデンシャルをアルファベット順にソートするには、[key name]、[user]、および [timestamp] 列をクリックします。 

    クレデンシャルの検索

    キー名、ユーザ、およびアプリケーションによってクレデンシャルを検索できます。 

    Anchor
    クレデンシャルの使用
    クレデンシャルの使用
    合成スクリプトでのクレデンシャルの使用

    合成スクリプトを使用して、合成クレデンシャル Vault に保存されているクレデンシャルを取得できます。キーの入力を開始すると、特定のアプリケーションに関連付けられているクレデンシャルが最初に表示されます。 

    1. コントローラ UI で合成ジョブを作成するには、[User Experience] > [Jobs] > [Add] に移動します。 
    2. 合成スクリプトを追加します。詳細については、「Write Your First Script」を参照してください。
    3. DOM 要素を特定します

    4. 構文 "<%key%>" を使用して対応するクレデンシャルを入力します。

      Code Block
      titleSynthetic Script
      driver.find_element_by_id("email").send_keys("<%email_key%>")
      driver.find_element_by_id("pass").send_keys("<%password_key%>")