Data Governance Broker Documentation Index
Configuration Reference Home

Verify 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 Verify Account Flow Handler may be used to verify the contact information of an end-user's account using an authentication chain, and update the account to indicate successful verification.

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

Parent Component

The Verify Account Flow Handler component inherits from the Account Flow Handler

Relations from This Component

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

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ authentication-chain
↓ account-verified-resource-attribute

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 verify the end-user account.
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

account-verified-resource-attribute

Description
The resource attribute paths that the Verify Account Flow Handler should allow the client to set after the end-user account is successfully verified using the authentication chain. Attributes submitted by the client not in this list will be ignored. Examples of valid attribute paths are:
  • 'name' - The 'name' attribute at the top level of the SCIM Resource Type resource.
  • 'urn:extension:organization' - The 'organization' attribute of a schema extension with URN 'urn:extension'.
  • 'addresses[type eq "preferred"].postalCode' - The postalCode sub-attribute of the address where the sub-attribute type equals 'preferred'. Only the equality filter on the type sub-attribute is supported as the value filter.

Default Value
The client will not be able to set any resource attributes.
Allowed Values
A string
Multi-Valued
Yes
Required
No
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 Verify Account Flow Handler:

dsconfig create-account-flow-handler
     --handler-name {name}
     --type verify
     --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}