Data Governance Broker Documentation Index
Configuration Reference Home

Password Recovery Account Flow Handler

Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.

Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.

The Password Recovery Account Flow Handler may be used to reset an end-user's password when they have forgotten their previous password.

Parent Component
Relations from This Component
Properties
dsconfig Usage

Parent Component

The Password Recovery Account Flow Handler component inherits from the Account Flow Handler

Relations from This Component

The following components have a direct aggregation relation from Password Recovery Account Flow Handlers:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ authentication-chain

Basic Properties

description

Description
A description for this Account Flow Handler
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 handler is enabled.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

authentication-chain

Description
Specifies the authentication chain that will be used to authenticate the end-user whose account to recover.
Default Value
None
Allowed Values
The DN of any Authentication Chain.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Account Flow Handlers:

dsconfig list-account-flow-handlers
     [--property {propertyName}] ...

To view the configuration for an existing Account Flow Handler:

dsconfig get-account-flow-handler-prop
     --handler-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Account Flow Handler:

dsconfig set-account-flow-handler-prop
     --handler-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Password Recovery Account Flow Handler:

dsconfig create-account-flow-handler
     --handler-name {name}
     --type password-recovery
     --set enabled:{propertyValue}
     --set authentication-chain:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Account Flow Handler:

dsconfig delete-account-flow-handler
     --handler-name {name}