CreateWalletKeyValue
Synopsis
[Actions]
CreateWalletKeyValue:Name="CollectionName.SecretName",RequireTLS="Boolean",AllowedHosts="HostList",Secret="secret",Usage="Protocols"
Where:
-
CollectionName.SecretName: The name of the secret and the collection to which it belongs.
-
Boolean: 1 (true) or 0 (false), whether TLS is required when the secret is transferred through an HTTP request.
-
AllowedHosts: A list of hosts that can receive the secret. This only applies if RequireTLS is true.
-
Secret: One or more key-value pairs. For example:
{"user":"myuser","password":"mypassword"} -
Protocols: A comma-delimited string or dynamic array specifying how the secret can be used. This can be any combination of the following:
-
HTTP: Secret can be used with %Net.HttpRequest.UseSecret()Opens in a new tab.
-
SOAP: Secret can be used with %SOAP.WebClient.UseSecret()Opens in a new tab.
-
CUSTOM: Allows you to retrieve the secret directly with %Wallet.KeyValue.GetSecretValue() (requires %Admin_Wallet:U)
-
Description
CreateWalletKeyValue creates a new key-value pair secret inside the specified collection. InterSystems IRIS® creates this secret when processing the [Actions] section during a configuration merge.
The CreateWalletKeyValue action accepts any of the properties listed as parameters in the class reference for the %Wallet.KeyValue.Create() method.
Changing This Operation
This operation is designed to be used during a configuration merge. You can change CreateWalletKeyValue by editing the merge file in a text editor (as described in Editing the Active CPF).
