@forgerock/javascript-sdk

Ping SDK for JavaScript

Change Log · Support · Docs

The Ping SDK for JavaScript enables you to quickly integrate Ping products into your JavaScript apps.

Use the SDKs to leverage Intelligent Access to easily step through each stage of an authentication tree by using callbacks.

Requirements

• ForgeRock Identity Platform

  • Ping Advanced Identity Cloud
  • PingAM 6.5.2+

• Browsers:

  • Chrome 87
  • Firefox 84
  • Safari 14
  • Edge 87 (Chromium)
  • Edge 44 (Legacy): requires one polyfill for TextEncoder, fast-text-encoding is recommended

Installation

npm install @forgerock/javascript-sdk

Getting Started

To try out the Ping SDK for JavaScript, perform these steps:

1. Setup your PingOne Advanced Identity Cloud tenant or PingAM instance.

   See Server configuration in the Documentation.

2. Clone this repo:

   git clone https://github.com/ForgeRock/sdk-sample-apps.git
   

3. In the root folder of the repo, use NPM to install dependencies:

   npm install
   

4. Open javascript/embedded-login/.env.example and edit the configuration values to match your server.

5. Save the file as .env in the same folder.

6. Run the sample app by using a simple HTTP server.

   • Run npm run start:embedded-login

7. In a supported web browser, navigate to https://localhost:8443.

Samples

We provide a sample repo to help demonstrate SDK functionality.

Documentation

Documentation for the SDKs is provided at https://docs.pingidentity.com/sdks, and includes topics such as:

• Introducing the SDK Features
• Preparing AM for use with the SDKS
• API Reference documentation

Support

If you encounter any issues, be sure to check our Troubleshooting pages.

Support tickets can be raised whenever you need our assistance; here are some examples of when it is appropriate to open a ticket (but not limited to):

• Suspected bugs or problems with ForgeRock software.
• Requests for assistance - please look at the Documentation and Knowledge Base first.

You can raise a ticket using the Ping Identity Support Portal that provides one stop access to support services.

The support portal shows all currently open support tickets and allows you to raise a new one by clicking New Ticket.

Version History

Our version history can be viewed by visiting our CHANGELOG.md.

Contributing

If you would like to contribute to this project you can fork the repository, clone it to your machine and get started.

Disclaimer

This code is provided by Ping Identity Corporation ("Ping") on an "as is" basis, without warranty of any kind, to the fullest extent permitted by law. Ping Identity Corporation does not represent or warrant or make any guarantee regarding the use of this code or the accuracy, timeliness or completeness of any data or information relating to this code, and Ping Identity Corporation hereby disclaims all warranties whether express, or implied or statutory, including without limitation the implied warranties of merchantability, fitness for a particular purpose, and any warranty of non-infringement. Ping Identity Corporation shall not have any liability arising out of or related to any use, implementation or configuration of this code, including but not limited to use for any commercial purpose. Any action or suit relating to the use of the code may be brought only in the courts of a jurisdiction wherein Ping Identity Corporation resides or in which Ping Identity Corporation conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions.

License

This project is licensed under the MIT License - see the LICENSE file for details

© Copyright 2020-2025 Ping Identity. All Rights Reserved