PingOne DaVinci API node

The PingOne DaVinci API node executes an API call to PingOne DaVinci to launch a specific DaVinci flow. This node lets an Identity Cloud journey trigger a PingOne DaVinci flow through the API integration method and does not render any front-end UI pages.

This node is only effective for DaVinci flows without a UI component, as it is using the DaVinci flow API integration.

To configure and use this node, Identity Cloud provides:

Dependencies

Before using this node, you must:

Prepare the PingOne DaVinci flow
Configure the input schema
Create a PingOne DaVinci application
Set up PingOne Service

Compatibility

Product	Compatible?
ForgeRock Identity Cloud	Yes
ForgeRock Access Management (self-managed)	Yes
ForgeRock Identity Platform (self-managed)	Yes

Product

Compatible?

ForgeRock Identity Cloud

Yes

ForgeRock Access Management (self-managed)

Yes

ForgeRock Identity Platform (self-managed)

Yes

Setup

This procedure only covers the steps and nodes required to prepare a PingOne DaVinci flow for invoking the API. It assumes that the PingOne DaVinci flow has been created already.

Prepare the PingOne DaVinci flow

In PingOne DaVinci, go to the Flows tab.
Find the flow you need, and click Edit.
1. At the end of the Success Path, add an HTTP node to send a JSON success response.
2. At the end of the Failure Path, add an HTTP node to send a JSON error response.
Click Save.
Click Deploy.

Refer to the PingOne DaVinci: Configuring the Flow page for further details.

Configure the input schema

The PingOne DaVinci API node sends the journey node state to the PingOne DaVinci flow. You must configure the node state as an input parameter for the PingOne DaVinci flow.

Click Input Schema on the DaVinci flow canvas.
Click Add to add an input parameter.
1. In the Parameter Name field, enter nodeState.
2. In the Data Type field, select Object.
Click Save.

Create a PingOne DaVinci application

In PingOne DaVinci, go to the Applications tab.
Click Add Application. The Add Application modal opens.
In the Name field, enter a name for the application, and click [.label]#Create.
Find the application you need and click Edit.
On the General tab, note down the values for Company ID and API Key.

You’ll need these to configure the PingOne DaVinci API node parameters.
Go to the Flow Policy tab.
Click + Add Flow Policy.
1. In the Name field, enter a name for the flow policy.
2. In the Flow List, select your flow.
3. In the Version List, select the desired flow version.
Click Create Flow Policy. The Edit Your Weight Distribution modal opens.
Click Save Flow Policy.
Note down the Policy ID of your flow policy. You’ll need it to configure the PingOne DaVinci API node parameters.

Refer to the PingOne DaVinci: Create Application page for further details.

Inputs

This node does not have any required input fields.

Configuration

The configurable properties for this node are:

Property Usage

Property	Usage
PingOne Service	The PingOne service used with this node.
Flow Policy ID	The PingOne DaVinci Flow Policy configured for the specific flow.
State Inputs	A list of state inputs that will be passed to PingOne DaVinci, the DaVinci Flow input schema includes the node state parameter. This is a multi-value field to select specific node state attributes which are to be included in the API request to PingOne DaVinci. By default, the wildcard `(*)` value will include the entire journey node state in the API request to PingOne DaVinci.

PingOne Service

The PingOne service used with this node.

Flow Policy ID

The PingOne DaVinci Flow Policy configured for the specific flow.

State Inputs

A list of state inputs that will be passed to PingOne DaVinci, the DaVinci Flow input schema includes the node state parameter. This is a multi-value field to select specific node state attributes which are to be included in the API request to PingOne DaVinci.

By default, the wildcard (*) value will include the entire journey node state in the API request to PingOne DaVinci.

Outputs

Any data configured to be returned to the PingOne DaVinci flow is put into the node state.

Outcomes

True: The PingOne DaVinci flow executed and returned a Success response.
False: The PingOne DaVinci flow executed and returned an Error response.
Error: An error occurred causing the request to fail. Check the response code, response body, or logs to see more details of the error.

Troubleshooting

If this node logs an error, review the log messages to find the reason for the error and address the issue appropriately.

Example

This example highlights the use of the PingOne DaVinci node in a user registration journey: