Connectors

PingOne Forms Connector

The PingOne Forms connector lets you include branded forms and messages in your PingOne DaVinci flow.

You can use the PingOne Forms connector to:

  • Build flows that include user experiences that you create on the Experiences → Forms tab in PingOne.

  • Show messages using the branding that you define on the Experiences → Branding & Themes tab in PingOne.

Forms are only supported in flows that integrate with your application using the Redirect method.

Setup

Resources

For information and setup help, see the following documentation:

Requirements

To use the connector, you’ll need a PingOne license.

Setting up PingOne Forms

Creating a form

If you want to include a form in your flow, create it in PingOne. For help, see Creating a form.

Configuring branding for a custom message

If you want to include a branded message in your flow, configure your branding in PingOne. For help, see Branding and themes.

Setting up the PingOne Forms connector configuration

In DaVinci, add a PingOne Forms connector. For help, see Adding a connector.

This connector doesn’t have a configuration at the environment level. You configure it in your flow instead.

Using the connector in a flow

Including a form in a flow

The Show Form capability lets you present any form that you create with the drag-and-drop form builder. You can optionally pre-populate form fields with variables from your flow.

For more information about creating forms, see Forms.

  1. In your flow, add the PingOne Forms connector and select the Show Form capability. Select the node that appears in your flow.

  2. In the Form list, select a form.

  3. (Optional) To include a social login button for users to sign on with social media, select a form that has social login configured in PingOne.

    1. Toggle Link with PingOne Use on or off. When enabled, DaVinci creates or updates a linked PingOne user account using attributes from the external IDP.

    2. Select a PingOne Population to use when authenticating the user.

  4. In the Form Theme list, select a theme for the form.

    This list is populated with themes configured in PingOne under User Experience → Branding & Themes. Each theme also has a unique Theme ID which can be copied and pasted into the connector after selecting Use Theme ID.

    If no theme is selected, the default PingOne Active Theme will be displayed.

  5. (Optional) In the Pre-Populate Field Values section, map flow variables to any fields that you want to be pre-populated when the user sees the form.

    A pair of screen captures showing a variable mapped in the Form Data section pre-populating a user’s email address in the user-facing form.

    1. Find the form field in the Key column.

    2. In the Value column, enter a static value or click {} to use a variable from your flow.

  6. (Optional) Click the Enable Device Profiling toggle to enable the PingOne Protect SDK to collect device information.

  7. (Optional) Click the Include Behavioral Data toggle to identify non-human activity through behavioral data collection.

    To enable Include Behavioral Data, you must first Enable Device Profiling.

  8. Click Apply.

Showing a message with your branding

The Show Branded Message capability lets you show the user a message within a frame that is branded according to the settings on the Experiences → Branding & Themes tab in PingOne.

A screen capture of an example branded message.

  1. In your flow, add the PingOne Forms connector and select the Show Branded Message capability. Select the node that appears in your flow.

  2. In the Message field, enter static text or click {} to include variables from your flow.

  3. In the Form Theme list, select a theme for the branded message.

    This list is populated with themes configured in PingOne under User Experience → Branding & Themes. Each theme also has a unique Theme ID which can be copied and pasted into the connector after selecting Use Theme ID.

    If no theme is selected, the default PingOne Active Theme will be displayed.

  4. Click Apply.

Capabilities

Show Form

Show a form from the drag-and-drop form builder.

Show details
Properties
Form dropDown required

The form to show. You can add forms in your PingOne environment. For a dynamic value or to use a form that isn’t listed, select "Use Form ID".

Link with PingOne User toggleSwitch

When enabled, DaVinci creates or updates a linked PingOne user account using attributes from the external IdP.

PingOne Population dropDown

The PingOne population to use when authenticating the user.

  • Use Population ID (Default)

Population ID textField

The ID of the PingOne population to use when authenticating the user, such as “aa4b3e81-cf7e-8685-4b7b-7ec89cfcf7c8”.

Pre-Populate Field Values keyValueList

You can show the form with some fields already completed. To pre-populate a form field, enter a value or select a variable from your flow.

Enable Device Profiling toggleSwitch

Enable PingOne Protect SDK to collect device information.

Include Behavioral Data toggleSwitch

When enabled, collects behavioral data to identify non-human activity. Enable Device Profiling must be enabled beforehand.

Input Schema
default object
form string required
theme string required
themeId string
linkWithP1User boolean
population string
populationId string
formData array
enableRisk boolean
collectBehavioralData boolean
Output Schema
output object
formData object
themeId string
event object
properties object
type string
buttonValue string

Show Branded Message

Show a message with your PingOne branding theme.

Show details
Properties
Message textArea

The message to show to the user.

Button Text textField

The text to show on the continue button, such as "Submit" or "Continue".

Default:

Submit
showContinueButton toggleSwitch

When enabled, the user interface includes a button that allows the user to continue the flow.

Input Schema
default object
theme string required
themeId string
message string
buttonText string
showContinueButton boolean
Output Schema
output object
themeId string