Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
Obscured Values can be used to store arbitrary values in the configuration that will be stored in obscured form, in which the plaintext representation is not obvious from its obscured representation. This may be particularly useful when developing Server SDK extensions that may need to store credentials used to access external systems or other sensitive information.
The values will be encrypted, but the encryption uses a hard-coded key. A determined attacker may be able to discover that encryption key, or may be able to obtain the plaintext representation of the value in some other way, so you should not rely purely on Obscured Values to ensure the absolute secrecy of these values. However, storing them in obscured form is better than storing them in the clear because they are at least protected from being deciphered from a casual observer. Further, Obscured Values are automatically suppressed from collect-support-data archives and other mechanisms that attempt to protect sensitive information.
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ obscured-value |
| Description | A description for this Obscured Value |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The value to be stored in an obscured form. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Obscured Values:
dsconfig list-obscured-values
[--property {propertyName}] ...
To view the configuration for an existing Obscured Value:
dsconfig get-obscured-value-prop
--value-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Obscured Value:
dsconfig set-obscured-value-prop
--value-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Obscured Value:
dsconfig create-obscured-value
--value-name {name}
--set obscured-value:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Obscured Value:
dsconfig delete-obscured-value
--value-name {name}