Removes a secret from a configured Secret Provider.
When no provider name is specified, the function searches all configured providers and removes the secret from the first provider that contains it.
Note: Not all Secret Providers support removal. Providers that are read-only (such as environment variables) will throw an exception when attempting to remove a value.
Lucee Function Reference
secretproviderremove()
Example
secretproviderremove(string key,[string name]):void
Arguments
The arguments for this function are set. You can not use other arguments except the following ones.
| Name | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Key of the secret to remove (e.g., "database.password", "api.key") |
| name | string | No | Name of the Secret Provider to remove from, as configured in .CFConfig.json. If not defined, the function searches all configured providers and removes from the first one that contains the key. |