Ping SDKs

Before you begin

To successfully complete this tutorial refer to the prerequisites in this section.

The tutorial also requires a configured server.

Compatibility

PingOne

  • Your PingOne instance must have DaVinci enabled.

DaVinci flows

Ensure your flows only use supported connectors, capabilities and fields for user interactions:

  • HTTP Connector

    • Custom HTML capability

      View supported fields
      HTTP Connector field and collector support

      Field (Collector)

      Description

      DaVinci module

      Android

      iOS

      JavaScript

      Text field

      (TextCollector)

      Collects a single text string.

      ✅

      1.0.0

      ✅

      1.0.0

      ✅

      1.0.0

      Password field

      (PasswordCollector)

      Collects a single text string that cannot be read from the screen.

      ✅

      1.0.0

      ✅

      1.0.0

      ✅

      1.0.0

      Submit Button

      (SubmitCollector)

      Sends the collected data to PingOne to continue the DaVinci flow.

      ✅

      1.0.0

      ✅

      1.0.0

      ✅

      1.0.0

      Flow Button

      (FlowCollector)

      Triggers an alternative flow without sending the data collected so far to PingOne.

      ✅

      1.0.0

      ✅

      1.0.0

      ✅

      1.0.0

      Label

      (LabelCollector)

      Display a read-only text label.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0

      Radio / Dropdown

      (SingleSelectCollector)

      Collects a single value from a choice of multiple options.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0
      HTTP Connector SK-Component support

      SK-Component (Collector)

      Description

      DaVinci module

      Android

      iOS

      JavaScript

      skIDP

      (IdpCollector)

      Presents a button to allow users to authenticate using an external identity provider, such as Apple, Facebook, or Google.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0
      View unsupported features

      Verify that your flow does not depend on any unsupported elements:

      SKPolling components

      SKPolling components cannot be processed by the SDK and should not be included.

      Variable field names

      You cannot use variables or other values from a node’s input schema in the names of any field used by the SDK.

      Images

      Images included in the flow cannot be passed to the SDK.

    For example, the PingOne sign-on with sessions DaVinci flow.

  • PingOne Form Connector

    • Show Form capability

      View supported fields
      Custom Fields support

      Field (Collector)

      Description

      DaVinci module

      Android

      iOS

      JavaScript

      Text Input

      (TextCollector)

      Collects a single text string.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0

      Password

      (PasswordCollector)

      Collects a single text string that cannot be read from the screen.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0

      Dropdown

      (SingleSelectCollector)

      Collects a value from a dropdown containing one or more text strings.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0

      Combobox

      (MultiSelectCollector)

      Collects a value from a dropdown containing one or more text strings, the user can enter their own text string.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0

      Radio Button List

      (SingleSelectCollector)

      Collects a value from one or radio buttons.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0

      Checkbox List

      (MultiSelectCollector)

      Collects the value of one or more checkboxes.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0
      Toolbox support

      Field (Collector)

      Description

      DaVinci module

      Android

      iOS

      JavaScript

      Flow Button

      (FlowCollector)

      Presents a customized button.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0

      Flow Link

      (FlowCollector)

      Presents a customized link.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0

      Translatable Rich Text

      (TextCollector)

      Presents rich text that you can translate into multiple languages.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0

      Social Login

      (IdpCollector)

      Presents a button to allow users to authenticate using an external identity provider, such as Apple, Facebook, or Google.

      ✅

      1.1.0

      ✅

      1.1.0

      ✅

      1.1.0

Prerequisites

Node and NPM

The SDK requires a minimum Node.js version of 18, and is tested on versions 18 and 20. To get a supported version of Node.js, refer to the Node.js download page.

You will also need npm to build the code and run the samples.

Server configuration

You must configure your PingOne instance for use with the DaVinci client.

Ask your PingOne administrator to complete the following tasks:

  • Configure a DaVinci flow

  • Create a DaVinci application

  • Configure PingOne for DaVinci flow invocation

To learn how to complete these steps, refer to Launching a flow with a Ping SDK in the PingOne DaVinci documentation.