Managing credentials in an external directory vault by using the IBM App Connect Enterprise Toolkit

You can use the IBM® App Connect Enterprise Toolkit to create or connect to an external directory vault and to manage credentials in the vault.

About this task

You can use the IBM App Connect Enterprise Toolkit to manage credentials in an external directory vault, by using options in the External Directory Vaults section of the Integration Explorer view. You can use these options to create an external directory vault, connect to an external directory vault, and to create, view, update, and delete credentials.

When you create an external directory vault, you can choose whether to create it in your workspace project or a file system directory. When an external directory vault has been created, you can create credentials in the vault by right-clicking the required vault in the Integration Explorer view and then clicking Create credential.

For a demonstration of how you can use the Toolkit to manage credentials, see the following videos:

Procedure

You can use the IBM App Connect Enterprise Toolkit to manage credentials in an external directory vault by completing the steps in the following tasks:

  • Creating an external directory vault
    1. Right-click External Directory Vaults in the Integration Explorer view of the Toolkit.
    2. Click Create an external directory vault.
    3. Click the Select button next to the External directory vault location field.
    4. Specify where you want the vault to be created by selecting either a workspace project name or a file system directory in which to store the vault.
    5. When you have specified the vault location, click OK.
    6. Specify a vault key to be used for accessing the vault.
    7. Click Finish.
  • Connecting to an existing external directory vault
    1. Right-click External Directory Vaults in the Integration Explorer view of the Toolkit.
    2. Click Connect to an external directory vault.
    3. Click the Select button next to the External directory vault location field.
    4. Specify the location of the vault by selecting either the workspace project name or file system directory that contains the external directory vault.
    5. When you have specified the vault location, click OK.
    6. Enter the vault key that is required to access the external directory vault.
    7. Optional: Select Save in toolkit preferences as the default vault to save the vault key, so that you will not need to re-enter it if the Toolkit is restarted.
      If you want to remove the external directory vault from the Integration Explorer view, you must remove the Toolkit preference first.
    8. Click Finish.
    9. If the vault contains any credentials, they are listed below the vault in the Integration explorer.
    10. You can display details of the credentials by clicking on them in the list.
      Values of properties that are marked as secret (such as password and apiKey) are not revealed, but values of non-secret properties (such as authType and credentialProvider) are shown.
  • Creating credentials in an external directory vault
    1. Expand the list of external directory vaults by clicking the arrow next to External Directory Vaults in the Integration Explorer view of the Toolkit.
    2. Right-click the external directory vault in which you want to create the credential and then click Create credential.
    3. Specify a name for the new credential, and select the Credential Type and Authentication Type.
      You can filter the credential types that are displayed in the drop-down list by typing characters in the text field.
    4. Specify values for the properties, such as the password and username.
    5. Click Finish.
  • Updating credentials in an external directory vault
    1. Expand the list of external directory vaults by clicking the arrow next to External Directory Vaults in the Integration Explorer view of the Toolkit.
    2. Click the arrow next to the external directory vault that contains the credential that you want to update. The credentials that are stored in the vault are listed, by credential type.
    3. Right-click the credential that you want to update and then click Update credential.
    4. In the Update a credential dialog, modify the values that you want to change and then press Enter.
      Secret properties are shown as six asterisks (******). To update a secret property value, remove all the characters and enter the new value for the secret property.
    5. Click Finish.
  • Deleting credentials from an external directory vault
    1. Expand the list of external directory vaults by clicking the arrow next to External Directory Vaults in the Integration Explorer view of the Toolkit.
    2. Click the arrow next to the external directory vault that contains the credential that you want to delete. The credentials that are stored in the vault are listed, by credential type.
    3. Right-click the credential that you want to delete and then click Delete credential.
    4. Click OK to confirm the deletion.