Secrets parameters
- Last UpdatedNov 05, 2025
- 1 minute read
- PI System
- Adapter for OPC UA 1.6
- Adapters
The following parameters are available for configuring secrets:
|
Parameter |
Required |
Type |
Description |
|---|---|---|---|
|
id |
Required |
string |
Id of configuration to be added, edited, or removed. Allowed value: any string that does not contain curly braces. For example, <secretId> is acceptable but {{<secretId>}}, {<secretId>}, <secret{Id> or {<secretId> are not. |
|
description |
Optional |
string |
The description of the secret. Allowed value: any string Note: The description field is metadata and not used in the adapter. |
|
expirationDate |
Optional |
datetime |
The secret's expiration date. Allowed formats: UTC: "yyyy-mm-ddThh:mm:ssZ"; Note: The expirationDate field is metadata and not used in the adapter. |
|
value |
Required |
string |
The secret's value. Allowed value: any string that is not explicitly enclosed by double curly braces. For example, <value>, {{{<value>}}, or {{<val{ue>}} is acceptable but {{<value>}} is not). |
Note: If the value is the masked value "***************", then the value will be unchanged from the previous configuration. The system returns an error if the masked value is used when no previous configuration for the Id exists.