HashiCorp Vault (IBM Vault) Policy
A HashiCorp Vault (IBM® Vault) policy contains the connection details that are used by a HashiCorp Vault (IBM Vault) Request node when you connect to a HashiCorp Vault (IBM Vault) application.
You can use a HashiCorp Vault (IBM Vault) Request node in a message flow to connect IBM App Connect Enterprise to HashiCorp Vault (IBM Vault) applications and issue requests to perform actions on objects such as config (you must be signed in to your account to view the objects linked to it). The HashiCorp Vault (IBM Vault) policy controls, at run time, access to the HashiCorp Vault (IBM Vault) application.
The HashiCorp Vault (IBM Vault) policy is created when you
configure a connection between a HashiCorp Vault (IBM Vault) Request node
and HashiCorp Vault (IBM Vault) by using the Connector Discovery
wizard. During the process of discovery, account credentials are stored in the vault and connection
details are stored in a HashiCorp Vault (IBM Vault) policy. The
policy is created with a type of HashiCorp Vault (IBM Vault), and the name of the
policy is returned to the HashiCorp Vault (IBM Vault) Request node and
specified in the Connection tab of the node, in the format
{policyProjectName}:policyName.
You can also create, update, or delete a HashiCorp Vault (IBM Vault) policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking .
You must deploy this policy before message flows that use the policy are started. If you redeploy a HashiCorp Vault (IBM Vault) policy, all message flows that are using the policy will be stopped and restarted.
For more information about using HashiCorp Vault (IBM Vault), see Using HashiCorp Vault (IBM Vault) with IBM App Connect Enterprise.
| Property | Property name in .policyxml file | Description of properties |
|---|---|---|
| HashiCorp Vault (IBM Vault) Application Type | applicationType | This property is reserved for future use and must be set to the value
online. |
| HashiCorp Vault (IBM Vault) Application Version | applicationVersion | This property is reserved for future use and must be set to the value
v1. |
| HashiCorp Vault (IBM Vault) Authentication method | authenticationMethod | This property specifies the type of authentication that is used for the
connection between IBM App Connect Enterprise and HashiCorp Vault (IBM Vault). This value is reserved for future use and
must be set to BASIC or BASIC_BEARER. |
| Server URL | apiUrl | Specify the URL for the API server that makes runtime calls. |
| Namespace | nameSpace | The namespace that you want to connect to within the vault server. |
| Mount path | mountPath | The mount path for the vault server that you want to connect to. If this authentication method was mounted using a non-default path, input it below. Otherwise Vault will assume the default path 'userpass'. |
| Engine path | enginePath | The engine path for the vault server that you want to connect to. |
| Proxy name | proxyId | The name of the proxy that you want App Connect to use to pass the connector
calls. This field is only required if calls need to go through a proxy. When using the IBM App
Connect Enterprise Toolkit, the proxy name should be specified in the form:
{PolicyProjectName}:HTTPProxyPolicyName |
| Credential Name | credentialName | The name of your HashiCorp Vault (IBM Vault)
account. For example, hashicorpvaultpolicy_HashiCorpVaultIBMVault_11 |