PingOne Verify Authentication node
The PingOne Verify Authentication node lets you integrate PingOne Verify biometric authentication functionality in your journey. The biometric authentication is achieved by comparing a stored picture to a live selfie.
Compatibility
| Product | Compatible? |
|---|---|
ForgeRock Identity Cloud |
Yes |
ForgeRock Access Management (self-managed) |
Yes |
ForgeRock Identity Platform (self-managed) |
Yes |
Inputs
This node reads these inputs from shared state:
The node reads the username from shared state.
To provide the username in shared state earlier in the journey, configure a node such as the Platform Username node.
Additionally, the node first looks in the shared state for the attribute containing the PingOne UserID and the reference picture attribute, which contains a Base64-encoded reference self-image in JPEG format. If these two attributes are not found in the shared state, the node looks up the user in the local datastore to retrieve the PingOne UserID and the reference picture.
If the PingOne UserID is not found in the local datastore or the shared store, a new user is created in PingOne to perform facial-biometric authentication.
Dependencies
You must configure PingOne Verify service before using this node.
Configuration
| Property | Usage |
|---|---|
PingOne Service |
Name of the service set up for PingOne, PingOne DaVinci API, PingOne Protect, and PingOne Verify nodes. |
PingOne Verify Policy ID |
The policy ID PingOne Verify node to use. The policy is expected to have the following details set:
|
Verify URL delivery mode |
QR code to display or E-mail/SMS for direct delivery. |
Let user choose the delivery method |
If selected, the user is prompted for a delivery method. |
Delivery message choice |
The message to display and allow user to select the delivery route (QR, SMS, eMail). The verify code displays along with the message. |
Reference Picture Attribute |
Transient state attribute name that contains the reference picture. |
Attribute containing the PingOne UserID |
Local attribute name that contains the PingOne UserID. |
Submission timeout |
Verification submission timeout in seconds. Value must be under authentication session validity time. |
Waiting message |
The message to display while waiting for the user to complete the authentication with PingOne Verify. |
Save verification metadata from PingOne Verify to Transient State |
Save verification explanation data from PingOne Verify to Transient State
with a key of |
Leave access token in transientState |
If checked, PingOne access token is preserved in transient state. |
Leave PingOne Verify transaction id in transientState |
If checked, PingOne access token is preserved in transient state, with a key of |
Save verification metadata from PingOne Verify to Transient State |
Save verification explanation data from PingOne Verify to Transient State
with a key of |
Leave access token in transientState |
If checked, PingOne access token is preserved in transient state, with a key of
|
Leave PingOne Verify transaction id in transientState |
If checked, PingOne transaction ID is preserved in transient state with a key of |
Demo mode |
When checked, the node always returns |
Outputs
If the outcome is Success (Patch ID) or Fail (Patch ID), the Attribute
containing the PingOne UserID key is placed in shared state and in the
objectAttribute object so the local user can be patched with the new user
GUID that was created in PingOne for the verification. Save the returned GUID
to the local user so the node doesn’t need to create a new PingOne user on the
next use.
Outcomes
Success-
Successfully authenticated the user’s stored selfie and live selfie.
Success (Patch ID)-
Successfully authenticated the user’s stored picture and live selfie. Additionally, if the stored GUID on the local user was invalid or did not exist, the node created a new PingOne user to perform the verification. The node stored the new user’s PingOne GUID in the shared state and in the objectAttribute, so the GUID can be used for future verification.
Fail-
Failed to authenticate the user’s stored picture and live selfie.
Fail (Patch ID)-
Failed to authenticate the user’s stored picture and live selfie.
Error-
There was an error during the authentication process.