PingAuthorize Server Documentation Index
Configuration Reference Home

Azure Key Vault Password Storage Scheme

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact support for assistance if you believe that you have a need to create or modify this type of object.

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:

For example, a password encoded with this scheme may look something like: 
 {AZURE-KEY-VAULT}{"secret":"secret-name"}

↓Parent Component
↓Relations from This Component
↓Properties
↓dsconfig Usage

Parent Component

The Azure Key Vault Password Storage Scheme component inherits from the Password Storage Scheme

Relations from This Component

The following components have a direct aggregation relation from Azure Key Vault Password Storage Schemes:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ key-vault-uri
↓ azure-authentication-method

Basic Properties

description

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

enabled

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

key-vault-uri

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

azure-authentication-method

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


dsconfig Usage

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}