ForgeRock SDKs

Compatibility

Supported versions

The ForgeRock SDKs support the following ForgeRock® Identity Platform versions:

  • AM 6.5, 7.0, 7.1, and later

  • Identity Cloud

Supported features

The ForgeRock SDKs support the following functionality:

  • OAuth 2.0

    Authorization code grant with PKCE

  • 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

  • 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)

    • Edge 44 (Legacy - requires fast-text-encoding polyfill).

    Older browsers such as Internet Explorer 11 can be supported by using polyfills. See Use polyfills.

Supported callbacks

Callback name Callback description Android iOS JavaScript

BooleanAttributeInputCallback SDK 2.1

Collects true or false.

✅

✅

✅

ChoiceCallback

Collects single user input from available choices, retrieves selected choice from user interaction.

✅

✅

✅

ConfirmationCallback

Retrieves the selected option from a list of options.

✅

✅

✅

ConsentMappingCallback SDK 2.0

Prompts the user to consent to share their profile data.

✅

❌

❌

DeviceBinding SDK 4.0

Cryptographically bind a mobile device to a user account.

✅

❌

❌

DeviceProfileCallback SDK 2.0

Collects meta and/or location data about the authenticating device.

✅

✅

✅

DeviceSigningVerifier SDK 4.0

Verify ownership of a bound device by signing a challenge.

✅

❌

❌

HiddenValueCallback

Returns form values that are not visually rendered to the end user.

✅

✅

✅

KbaCreateCallback SDK 2.0

Collects knowledge-based answers. For example, the name of your first pet.

✅

✅

✅

MetadataCallback

Injects key-value metadata into the authentication process.

✅

✅

✅

NameCallback

Collects a username.

✅

✅

✅

NumberAttributeInputCallback SDK 2.1

Collects a number.

✅

✅

✅

PasswordCallback

Collects a password or one-time pass code.

✅

✅

✅

PollingWaitCallback

Instructs an application to wait for the given period and resubmit the request.

✅

✅

✅

ReCaptchaCallback

Provides credentials to process Captcha in native applications.

✅(1)

✅

✅

RedirectCallback

Redirects the user’s browser or user-agent.

❌

❌

✅

StringAttributeInputCallback SDK 2.0

Collects the values of attributes for use elsewhere in a tree.

✅

✅

✅

SuspendedTextOutputCallback SDK 2.1

Pause and resume authentication, sometimes known as "magic links".

✅

✅

✅

TextInputCallback SDK 3.4.0

Collects text input from the end user. For example, a nickname for their account.

❌

❌

✅

TextOutputCallback

Provides a message to be displayed to a user with given message type.

✅

✅

✅

TermsAndConditionsCallback SDK 2.0

Collects a user’s acceptance of the configured Terms & Conditions.

✅

✅

✅

ValidatedCreatePasswordCallback SDK 2.0

Collects a password value, with optional password policy validation.

✅

✅

✅

ValidatedCreateUsernameCallback SDK 2.0

Collects a username value, with optional username policy validation.

✅

✅

✅

(1) Requires the presence of Google Play Services.

Copyright © 2010-2023 ForgeRock, all rights reserved.