PingOne

Adding device profiling to a browser-based authentication page using the PingOne Risk (Signals) SDK with integration kit 1.3.1

About this task

You can adapt these instructions to add device profiling to any page, such as the HTML Form Adapter or your web application. The page must meet the criteria listed in Device profiling methods.

PingOne Risk Integration Kit version 1.3.1 must be deployed before any changes can be made on the HTML side. SDK version 5.2 and later requires adapter version 1.3.1 or later.

Steps

  1. If you are modifying an external web application, copy the following files from the integration .zip archive to a location that your page can access.

    • pingone-risk-profiling-signals-sdk.js

    • pingone-risk-management-embedded.js

    • signals-sdk-<version>.js

  2. Optional: Edit the pingone-risk-profiling-signals-sdk.js file and add your PingOne environment ID.

    function profileDevice(callback) {
        // Initialize the SDK
        // replace <envid> with the PingOne console > Environment > Environment ID value
        onPingOneSignalsReady(function () {
            _pingOneSignals.initSilent({
                 envId: "<envid>",
                behavioralDataCollection: false,
                deviceAttributesBlackList: []
            }).then(function ()
  3. Add the following external script references to the sign-on page:

    The scripts must be added in the following order.

    <script type="text/javascript" src="signals-sdk-<version>.js"></script>
    <script type="text/javascript" src="pingone-risk-profiling-signals-sdk.js"></script>
    <script type="text/javascript" src="pingone-risk-management-embedded.js"></script>
  4. Optional: Customize the device profile cookie name prefix to suit your environment.

    1. Open pingone-risk-management-embedded.js for editing.

    2. On the following line, change the value to a name of your choosing:

      var cookieNamePrefix = "pingone.risk.device.profile";
    3. Save the file.

  5. When you complete the steps in Configuring an adapter instance, follow the instructions to set the Device profiling method to Captured by a previous adapter. Update the Cookie Name Prefix field if you customized it above.