Adding device profiling to a browser-based authentication page - PingOne Services - PingOne Risk - PingOne Cloud Platform - PingOne

PingOne Risk Integration Kit

bundle
pingfederate-pingone-risk-ik
ft:publication_title
PingOne Risk Integration Kit
Product_Version_ce
PingOne Services
PingOne Risk
PingOne Cloud Platform
PingOne
category
Administrator
Audience
ContentType
English
Integration
Language
OtherDocs
Product
Productdocumentation
integrationdoc
p1
p1cloudplatform
p1riskx
p1services
ContentType_ce
Product documentation
Integration

There are two ways for device profiling data to be collected; by the PingOne Risk IdP Adapter, or by a previous adapter such as the HTML Form Adapter. Getting the device profile on the HTML Form Adapter page reduces the perceived wait times for the user. For more information, see Device profiling methods.

Page created: 27 Mar 2023 |
Page updated: 16 Jun 2023

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

Page created: 28 Mar 2023 |
Page updated: 16 Jun 2023
| 2 min read

PingOne Cloud Platform PingOne PingOne Services PingOne Risk Product Other Documents Integrations Language English Integration Content Type Product documentation Audience Administrator

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.

Important:

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.

  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:
    Important:

    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.

Adding device profiling to a browser-based authentication page using the PingOne Risk (Signals) SDK and integration kit 1.3 or earlier

Page created: 4 Oct 2022 |
Page updated: 16 Jun 2023
| 2 min read

PingOne Cloud Platform PingOne PingOne Services PingOne Risk Product Other Documents Integrations Language English Integration Content Type Product documentation Audience Administrator

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.

  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.js
  2. Edit the pingone-risk-profiling-signals-sdk.js file and add your PingOne environment ID.
    Important:

    The PingOne Risk SDK won't work if the PingOne environment ID is missing.

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

    The scripts must be added in the following order.

    <script type="text/javascript" src="signals-sdk.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.

Adding device profiling to a browser-based authentication page using Fingerprint JS

Page created: 4 Oct 2022 |
Page updated: 16 Jun 2023
| 2 min read

PingOne Cloud Platform PingOne PingOne Services PingOne Risk Product Other Documents Integrations Language English Integration Content Type Product documentation Audience Administrator

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.

Note:

The PingOne Risk (Signals) SDK is the preferred way to get device profiling and is recommended for use in the PingOne Risk Integration Kit 1.3 and later.

  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.
    • fingerprint2-<version>.min.js
    • pingone-risk-management-profiling.js
    • pingone-risk-management-embedded.js
  2. Add the following external script references to the sign-on page:
    Important:

    The scripts must be added in the following order.

    <script type="text/javascript" src="fingerprint2-<version>.min.js"></script>
    <script type="text/javascript" src="pingone-risk-management-profiling.js"></script>
    <script type="text/javascript" src="pingone-risk-management-embedded.js"></script>
  3. Edit the pingone-risk-management-embedded.js file to use Fingerprint JS according to the comments in the file.
  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.