Compatibility
Supported versions
The ForgeRock SDKs support the following ForgeRock® Identity Platform versions:
-
AM 6.5, 7.0, 7.1, 7.2, 7.3, 7.4, 7.5 and later
-
ForgeRock Identity Cloud
Supported features
The ForgeRock SDKs support the following functionality:
-
OAuth 2.0
-
Authentication trees and nodes
The SDKs do not support authentication chains nor modules. -
Prototyping with FRUI module
The FRUI module is for prototyping your UI, and is not intended for production use, as-is.
Supported operating systems
The ForgeRock SDKs are compatible with the following versions:
-
ForgeRock Android SDK
-
Android 6.0 (Marshmallow)
-
Android 7.0 / 7.1 (Nougat)
-
Android 8.0.0 / 8.1.0 (Oreo)
-
Android 9 (Pie)
-
Android 10
-
Android 11
-
Android 12
-
Android 13
-
Android 14
-
-
ForgeRock iOS SDK
-
iOS 12
-
iOS 13
-
iOS 14
-
iOS 15
-
iOS 16
-
-
ForgeRock JavaScript SDK
-
Chrome 83
-
Firefox 77
-
Safari 13
-
Edge 83 (Chromium)
-
Supported callbacks
| Callback name | Callback description | Android | iOS | JavaScript |
|---|---|---|---|---|
|
Collects a generated token from the client to verify the integrity of the app |
✅ SDK 4.3 |
✅ SDK 4.3 |
❌ |
SDK 2.1 |
Collects true or false. |
✅ |
✅ |
✅ |
|
Collects single user input from available choices, retrieves selected choice from user interaction. |
✅ |
✅ |
✅ |
|
Retrieve a selected option from a list of options. |
✅ |
✅ |
✅ |
SDK 2.0 |
Prompts the user to consent to share their profile data. |
✅ |
❌ |
❌ |
|
Cryptographically bind a mobile device to a user account. |
✅ SDK 4.0 |
✅ SDK 4.0 |
❌ |
SDK 2.0 |
Collects meta and/or location data about the authenticating device. |
✅ |
✅ |
✅ |
|
Verify ownership of a bound device by signing a challenge. |
✅ SDK 4.0 |
✅ SDK 4.0 |
❌ |
|
Returns form values that are not visually rendered to the end user. |
✅ |
✅ |
✅ |
|
Collects knowledge-based answers. For example, the name of your first pet. |
✅ |
✅ |
✅ |
|
Injects key-value metadata into the authentication process. For example, the WebAuthn nodes use this callback to return the data the SDK requires to perform authentication and registration. |
✅ |
✅ |
✅ |
|
Collects a username. |
✅ |
✅ |
✅ |
SDK 2.1 |
Collects a number. |
✅ |
✅ |
✅ |
|
Collects a password or one-time pass code. |
✅ |
✅ |
✅ |
SDK 4.4 |
Collects captured contextual data from the client to perform risk evaluations. |
✅ |
✅ |
✅ |
SDK 4.4 |
Instructs the client to start capturing contextual data for risk evaluations |
✅ |
✅ |
✅ |
|
Instructs the client to wait for the given period and resubmit the request. |
✅ |
✅ |
✅ |
|
Provides credentials to process Captcha in native applications. |
✅ (2) |
✅ |
✅ |
|
Redirects the user’s browser or user-agent. |
❌ |
❌ |
✅ |
SDK 2.0 |
Collects the values of attributes for use elsewhere in a tree. |
✅ |
✅ |
✅ |
SDK 2.1 |
Pause and resume authentication, sometimes known as "magic links". |
✅ |
✅ |
✅ |
|
Collects text input from the end user. For example, a nickname for their account. |
✅ SDK 4.4 |
✅ SDK 4.4 |
✅ SDK 3.4 |
|
Provides a message to be displayed to a user with a given message type. |
✅ |
✅ |
✅ |
SDK 2.0 |
Collects a user’s acceptance of the configured Terms & Conditions. |
✅ |
✅ |
✅ |
SDK 2.0 |
Collects a password value with optional password policy validation. |
✅ |
✅ |
✅ |
SDK 2.0 |
Collects a username value with optional username policy validation. |
✅ |
✅ |
✅ |
(1) The WebAuthn Authentication node and the WebAuthn Registration node both use a MetaDataCallback when the Return challenge as JavaScript is NOT enabled.
You must not enable this option when handling WebAuthn journeys with the ForgeRock SDK for Android and iOS.
The ForgeRock SDK for JavaScript handles either the MetaDataCallback or the JavaScript-based payload.
(2) Requires the presence of Google Play Services.