After you configure PingOne and test the solution using the wizard, perform additional configuration in DaVinci to enable all features and make the flows available to end users.
-
Enter or verify the values for each company variable that's used in the
PingOne for Customers Plus
solution.
These variables determine whether some processes and subflows are included or excluded.
Note:If you plan to invoke the flow using the widget, you can pass in parameter values that override some of these variables. These parameters are described later in this procedure.
- In DaVinci, click the Variables tab.
- Locate a variable and click the Pencil icon.
- In the Value field, verify that the value is correct, or enter a new value for the variable.
- Click Update.
- Repeat steps b-d for each remaining variable.
Company variablesCompany variables Variable
Description
ciam_sessionLengthInMinute
The maximum allowed session length for a user in the flow.
The default value is 5 minutes.
ciam_appleEnabled
A boolean that controls whether Apple is enabled as a social sign-on option.
The default value is
true
.ciam_facebookEnabled
A boolean that controls whether Facebook is enabled as a social sign-on option.
The default value is
true
.ciam_googleEnabled
A boolean that controls whether Google is enabled as a social sign-on option.
The default value is
true
.ciam_voiceOtpEnabled
A boolean that controls whether one-time passcode using voice is enabled in your environment.
The default value is
true
.ciam_mobilePushOtpEnabled
A boolean that controls whether one-time passcode using mobile push is enabled in your environment.
The default value is
true
.ciam_totpEnabled
A boolean that controls whether time-based one-time passcodes are enabled in your environment.
The default value is
true
.ciam_otpFallbackAllowed
A boolean indicating whether a user canfall back to an otp if a mobile push request times out.
The default value is
true
.hideSkipButton
A boolean indicating whether the skip option should be presented for MFA enablement.
The default value is
false
.ciam_endUserErrMsg
A string that is displayed to the user in an error message if an unexpected error occurs.
The default value is
An error occurred
.ciam_requireMFA
A boolean that controls whether MFA is required for all users.
The default value is
true
.ciam_resendOtpLimit
The maximum number of times a user can resend a one-time passcode.
The default value is
5
.ciam_passwordlessRequired
A boolean that controls whether all end users must use passwordless authentication.
The default value is
true
.ciam_magicLinkEnabled
A boolean that controls whether magic links are enabled for your end users.
The default value is
true
.ciam_logoUrl
The URL for the version of your company logo to display in flows.
The default value is
https://assets.pingone.com/ux/ui-library/5.0.2/images/logo-pingidentity.png
.ciam_logoStyle
The CSS style to use for your company logo.
The default value is
width: 65px; height: 65px;
.ciam_companyName
The name of your company as it should be displayed in user-facing text.
The default value is
Ping Identity
.ciam_agreementEnabled
A boolean that controls whether agreement is enabled in your environment.
The default value is
true
.ciam_agreementId
The ID of the agreement to present to users if agreement is enabled.
This value was copied in the Configuring PingOne procedure. There is no default value.
ciam_recoveryLimit
The maximum number of times a user can attempt to recover an account.
The default value is
5
.ciam_verificationLimit
The maximum number of times a user can attempt to verify their email address.
The default value is
5
.ciam_smsOtpEnabled
A boolean that controls whether one-time passcode using SMS is enabled in your environment.
The default value is
true
.ciam_emailOtpEnabled
A boolean that controls whether one-time passcode using email is enabled in your environment.
The default value is
true
.ciam_fidoPasskeyEnabled
A boolean that controls whether FIDO passkey is enabled in your environment.
The default value is
true
.ciam_accountRecoveryEnabled
A boolean that controls whether account recovery is enabled in your environment.
The default value is
true
. -
Verify the configuration of the following connectors in your environment.
Connector
Description
Connector documentation
PingOne
Enables DaVinci to view and update PingOne user information.
PingOne MFA
Enables DaVinci to use the PingOne MFA service for multi-factor authentication.
PingOne Notifications
Enables DaVinci flows to send users general communications via SMS, email, and voice message with PingOne’s notifications feature.
- On the Connectors tab, find the connector that you want to verify and click ... > Edit..
- Verify that the Environment ID and Client ID fields match your PingOne values.
- If you have made any changes to the values, click Apply.
- Repeat the previous steps for each remaining connector.
-
Configure the PingOne
Authentication node.
- Click Flows.
- Select the CIAM Plus - Registration and Authentication with Username and Password - Main Flow and click ... > Edit.
- In the Return Success section, click the PingOne Authentication node.
- Verify that the PingOne Application list is set to Use Application ID.
- Verify that your Application ID is present in the Application ID field.
- Click Apply.
- Click Save.
-
If you want to use social sign-on, update the
skIdp
component in the CIAM Plus - Registration and Authentication with Username and Password - Main Flow flow to use your PingOne identity provider (IdP).- Click Flows.
- Select the CIAM Plus - Registration and Authentication with Username and Password - Main Flow flow and click ... > Edit.
- Click the Password Sign On Page node.
-
Click the
skIdp
component corresponding to a social IdP option you want to provide.The section of the node contents that contains these components looks like this:
{{#if googleEnabled}} {{skIDP}} {{/if}} {{#if facebookEnabled}} {{skIDP}} {{/if}} {{#if appleEnabled}} {{skIDP}} {{/if}}
- In the Identity Provider Connector list, select PingOne Authentication.
- In the PingOne External Identity Provider list, select an external IdP.
- Select Link with PingOne User.
- In the PingOne Population list, select Default.
- Click Save.
- Click Apply.
- Repeat steps d-j for each other social IdP option you want to use.
- Click the Passwordless Sign On Page node and repeat steps d-k.
-
Verify
or add values for the Agreement ID and MFA Policy
ID.
- Click Flows.
- Select the CIAM Plus - Registration and Authentication with Username and Password - Main Flow flow and click ... > Edit.
- Click the Set Flow Constants node.
-
For
the
ciam_agreementID
variable value, enter the Agreement ID value you copied in the Configuring PingOne procedure if it is not present.Note: If your environment has only one agreement, this value is automatically populated. -
For the
ciam_mfaPolicyID
variable value, enter the MFA policy ID you want to use.Note: If you do not enter an MFA policy ID, the default policy is used. - Click Apply.
- Click Save.
-
Repeat steps c-g in the following flows:
- CIAM Plus - Profile Management - View Agreement TOS - Main Flow
- CIAM Plus - SignOn - Subflow
-
If you want to launch the solution using the widget, add your company
name.
- Click Flows.
- Select the CIAM Plus - Registration and Authentication with Username and Password - Main Flow flow and click ... > Edit.
- Click the Set Industry Variables node.
-
In the Code section, update the text to include
your company name. For example:
const flowCompanyGreeting = (flowMethod === 'WIDGET' ) ? '<p class="text-muted text-center mb-5">Welcome to Company Name</p>' : `<p class="text-muted text-center">Welcome to ${ciam_companyName}</p>`;
- Click Apply.
-
Verify that the PingOne
flow setting is correct for your environment.
- If you want to launch the PingOne for Customers Plus solution using a redirect, the flow must be configured as a PingOne flow.
- If you want to launch the PingOne for Customers Plus solution using the widget, the flow must not be configured as a PingOne flow.
- Click Flows.
- Click the CIAM Plus - Registration and Authentication with Username and Password - Main Flow flow.
- Click More Options (⋮) > Flow Settings.
- If you plan to launch the flow through a redirect, click the PingOne Flow toggle.
- If you made changes to the flow settings, click Save,close the flow settings pane, and clickDeploy.
- If you plan to use the profile management flows, repeat steps a-e for the CIAM Plus - MFA Device Management - Main Flow, CIAM Plus - User Profile Management - Main flow, and CIAM Plus - Profile Management - Change Password - Main Flow flows.
-
Configure a DaVinci application with a
flow policy that invokes the CIAM Plus - Registration and Authentication with Username and Password - Main Flow flow. For more information, see Creating an application.
- On the Applications tab, click Add Application.
- In the Name field, enter a name for the application.
- Click Create.
-
Create a flow policy for the application you created.
For more information, see Configuring a flow policy.
- On the Applications tab, find the application you created and click Edit.
- On the Flow Policy tab, click Add Flow Policy.
- In the Name field, enter a name for the flow policy.
- Select PingOne Flow Policy if you plan to invoke the flow using a PingOne redirect.
-
In the Flows section, select a flow.
Note:
To launch the PingOne for Customers Plus solution, select the CIAM Plus - Registration and Authentication with Username and Password - Main Flow flow. To launch a device management flow, select CIAM Plus - Profile Management - Change Password - Main Flow or CIAM Plus - MFA Device Management - Main Flow.
- In the Version section, select one or more versions of the flow to use.
- Click Create Flow Policy.
- In the Distribution field, set the weight for the CIAM - Main flow to 100.
- Click Save Flow Policy.
- Click Apply.
-
If you are using a test environment, move the flows to your production
environment:
- In your testing environment, click Flows.
- Click the CIAM Plus - Registration and Authentication with Username and Password - Main Flow flow.
-
Click More options (⋮) > Download Flow JSON.
The Export Flow panel opens.
-
Click Yes.
The flow and its subflows are downloaded locally.
- Sign on to your production environment and click Flows.
- Click Add Flow > Import from JSON.
- Select the JSON file containing the flows.
- Click Import.
- Optional: Repeat steps a-h for the CIAM Plus - MFA Device Management - Main Flow, CIAM Plus - User Profile Management - Main flow, and CIAM Plus - Profile Management - Change Password - Main Flow flows.
- Repeat steps 1-14 in your production environment.
-
If you imported the CIAM Plus - MFA Device Management - Main Flow or CIAM Plus - Profile Management - Change Password - Main Flow flows, remove the duplicate copies of
the CIAM Plus - Device Registration - Subflow and CIAM Plus - Change Password - Subflow flows.
The duplicate copies of the flows have
- 1
appended to the flow name.- Click Flows.
- Find the OOTB - Device Registration - Subflow - 1 flow and click ... > Delete, then click Delete in the confirmation window.
- Find the OOTB - Change Password - Subflow - 1 flow and click ... > Delete, then click Delete in the confirmation window.
- Click the CIAM Plus - MFA Device Management - Main Flow.
- Click the Flow Conductor connector, then replace the contents of the Flow ID field with the CIAM Plus - Device Registration - Subflow flow.
- Click Save.
- Click Deploy.
- Click Flows.
- Click the CIAM Plus - Profile Management - Change Password - Main Flow.
- Click the Flow Conductor connector, then replace the contents of the Flow ID field with the CIAM Plus - Change Password - Subflow flow.
- Click Save.
- Click Deploy.
-
Invoke the flow or flows using the widget or a redirect.
- If you want to launch the flow in a separate window using a PingOne redirect, use the procedure in Launching a PingOne flow with a redirect. The CIAM Plus - Registration and Authentication with Username and Password - Main Flow flow can be launched with a redirect.
- If you want to launch the flow in a widget within the user's current
window, use the procedure in Launching a flow with the widget. The following
flows can be launched with the widget:
- CIAM Plus - Registration and Authentication with Username and Password - Main Flow
- CIAM Plus - MFA Device Management - Main Flow
- CIAM Plus - User Profile Management - Main flow
- CIAM Plus - Profile Management - Change Password - Main Flow
Note:When you invoke the flow using the widget, you must include your company logo as a background image in thedialog-content-header__logo
CSS class. For example:.dialog-content-header__logo { background-image: url("./company-logo.svg"); }
Note:ParametersWhen you invoke the flow using the widget, you can include any of the following parameters. When present, the parameter value is used instead of the corresponding variable value.
Use the following format to pass parameters to the flow:
flowParameters:{ parameter1: "value", parameter2: "value" }
Parameters Parameter
Corresponding variable
Description
isAppleEnabled
ciam_appleEnabled
A boolean indicating whether Apple is enabled as a social sign-on option.
isFacebookEnabled
ciam_facebookEnabled
A boolean indicating whether Facebook is enabled as a social sign-on option.
isGoogleEnabled
ciam_googleEnabled
A boolean indicating whether Google is enabled as a social sign-on option.
isPasswordlessRequired
ciam_passwordlessRequired
A boolean indicating whether all end users must use passwordless authentication.
isEmailMagicLinkEnabled
ciam_magicLinkEnabled
A boolean indicating whether magic links are enabled for your end users.
isTermsOfServiceEnabled
ciam_agreementEnabled
A boolean indicating whether agreement is enabled in your environment.
isSmsOTPEnabled
ciam_smsOtpEnabled
A boolean indicating whether one-time passcode using SMS is enabled in your environment.
isEmailOTPEnabled
ciam_emailOtpEnabled
A boolean indicating whether one-time passcode using email is enabled in your environment.
isFidoPasskeyEnabled
ciam_fidoPasskeyEnabled
A boolean indicating whether FIDO passkey is enabled in your environment.
isAccountRecoveryEnabled
ciam_accountRecoveryEnabled
A boolean indicating whether account recovery is enabled in your environment.