Vault Key type
Use the Vault Key type to create configurations that
supply a vault key, which provides access to an IBM® App Connect Enterprise vault that
stores credentials for connecting to secured resources.
Vault Key type works with the
Vault type, so you need both of these configurations if your IBM App Connect Enterprise
Toolkit integration is configured to connect to secured
resources.Deprecated
The Vault and Vault Key types are deprecated in IBM App Connect Operator
12.11.0. Switch to using the
Vault archive and Vault archive key types, which enable you to
create configuration objects that contain encrypted credentials that are exported from an
integration server vault or external directory vault in IBM App Connect Enterprise.
You can create configuration objects of type Vault archive and Vault
archive key for use with integration servers and integration runtimes at
version 13.0.3.0-r1 or later.
Summary of key details for the configuration type
| File name or type | Contains secrets | Path extracted/imported to | Maximum allowed per integration server or integration runtime |
|---|---|---|---|
| String value | Yes | Not applicable (Passed to the integration server or integration runtime command line on startup) | 1 |
About the Vault Key value
The Vault Key type requires a string value that the integration server or integration runtime uses to access the credentials in the vault. The
vault key must be at least 8 characters in length. Only one vault key can be specified per integration server or integration runtime. When the integration server or integration runtime starts, the value of the vault key in the
configuration object is read and is passed to the command
line.
The vault key must match the value that you provided when the vault was created. This vault key is also used when you use the IBM App Connect Enterprise Console to run the mqsivault command or mqsicredentials command. For more information, see also Configuring encrypted security credentials and Connecting client applications in the IBM App Connect Enterprise documentation.
Creating a configuration for the Vault Key type by using the configuration panel
You can create a Vault Key-type configuration while creating an integration server or integration runtime, or independently, as follows:
- Open the Configuration page by clicking the
Configuration icon
in the navigation pane, or go to the Configuration view of an integration server or integration runtime that you are creating. Then, click
Create configuration. For more information, see Managing configuration objects from the Configuration page. - From the
Create configuration
panel, select Vault Key from the Type list. - In the Name field, specify a name for this configuration.
- In the Description field, specify text that will help you identify the
Vaultconfiguration object that the vault key is associated with.
- In the Vault Key section, enter the string value of the vault key
directly into the text editor.
- Click Create. The configuration is added to the configurations table and can be selected for use with an integration server or integration runtime.
Updating or deleting a configuration
If you need to update the content or settings in a configuration, or delete a configuration that's no longer needed, see Managing configuration objects from the Configuration page.