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.
The Azure Key Vault Password Storage Scheme provides a mechanism for authenticating users whose passwords are stored in the Microsoft Azure Key Vault service.
This password storage scheme only supports authenticating users and does not allow password changes. Password changes must be made in the Azure Key Vault service.
When updating a user account to use this password storage scheme, the password must be provided in pre-encoded form (which will likely require using the password update behavior request control with the allowPreEncodedPassword element set to true). The encoded password should consist of the prefix "{AZURE-KEY-VAULT}" followed by a JSON object with the following fields:
{AZURE-KEY-VAULT}{"secret":"secret-name"}
The Azure Key Vault Password Storage Scheme component inherits from the Password Storage Scheme
The following components have a direct aggregation relation from Azure Key Vault Password Storage Schemes:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| enabled | |
| key-vault-uri | |
| azure-authentication-method | |
| http-proxy-external-server |
| Description | A description for this Password Storage Scheme |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Password Storage Scheme is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The URI that identifies the Azure Key Vault from which the secret is to be retrieved. |
| Default Value | None |
| Allowed Values | An absolute URL, or a relative URL |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The mechanism used to authenticate to the Azure service. |
| Default Value | None |
| Allowed Values | The DN of any Azure Authentication Method. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | A reference to an HTTP proxy server that should be used for requests sent to the Azure service. |
| Default Value | No HTTP proxy server will be used. |
| Allowed Values | The DN of any HTTP Proxy External Server. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Password Storage Schemes:
dsconfig list-password-storage-schemes
[--property {propertyName}] ...
To view the configuration for an existing Password Storage Scheme:
dsconfig get-password-storage-scheme-prop
--scheme-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Password Storage Scheme:
dsconfig set-password-storage-scheme-prop
--scheme-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Azure Key Vault Password Storage Scheme:
dsconfig create-password-storage-scheme
--scheme-name {name}
--type azure-key-vault
--set enabled:{propertyValue}
--set key-vault-uri:{propertyValue}
--set azure-authentication-method:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Password Storage Scheme:
dsconfig delete-password-storage-scheme
--scheme-name {name}