ForgeRock SDKs

Incompatible changes

Incompatible changes refer to changes that impact existing functionality and might have an effect on your deployment. Before you upgrade, review these lists and make the appropriate changes to your scripts and plugins.

SDK for Android 4.0.0

Removed support for native single sign-on (SSO)

The Android platform has deprecated sharedUserId that underpins the ForgeRock SDK for Android native SSO implementation.

This native SSO implementation will not be viable after sharedUserId is removed from the Android platform.

Due to this deprecation, SDK for Android 4.0.0 removes support for Android native single sign-on, as well as the following related changes:

  • AuthenticatorService is removed. Remove <service> from your AndroidManifest.xml file.

  • The SDK for Android no longer requires the following permissions:

    • android.permission.AUTHENTICATE_ACCOUNTS

    • android.permission.GET_ACCOUNTS

    • android.permission.MANAGE_ACCOUNTS

    • android.permission.USE_CREDENTIALS

  • The SDK for Android no longer requires the following configuration properties:

    • forgerock

    • forgerock_account_name

    • forgerock_webauthn_account_name

    • forgerock_webauthn_max_credential

    • forgerock_enable_sso

Method signature changes

The signature of the following methods has changed.

WebAuthnRegistrationCallback
Old New 
public void register(Node node,FRListener<Void> listener)
 
suspend fun register(context: Context, node: Node)
WebAuthAuthenticationCallback
Old New 
public void authenticate(
  @NonNull Fragment fragment,
  @NonNull Node node,
  @Nullable WebAuthnKeySelector selector,
  FRListener<Void> listener
)
 
suspend fun authenticate(
  context: Context,
  node: Node,
  selector: WebAuthnKeySelector = WebAuthnKeySelector.DEFAULT)
org.forgerock.android.auth.FRAClient
Old New 
public boolean updateAccount(@NonNull Account account)
 
public boolean updateAccount(@NonNull Account account)
  throws AccountLockException
org.forgerock.android.auth.HOTPMechanism
Old New 
public OathTokenCode getOathTokenCode()
  throws OathMechanismException
 
public OathTokenCode getOathTokenCode()
  throws OathMechanismException, AccountLockException
org.forgerock.android.auth.OathMechanism
Old New 
public abstract OathTokenCode getOathTokenCode()
  throws OathMechanismException
 
public abstract OathTokenCode getOathTokenCode()
  throws OathMechanismException, AccountLockException
org.forgerock.android.auth.TOTPMechanism
Old New 
public OathTokenCode getOathTokenCode()
  throws OathMechanismException
 
public OathTokenCode getOathTokenCode()
  throws OathMechanismException, AccountLockException

SDK for JavaScript 4.0.0

No longer provides Universal Module Definition (UMD) support

This version of the SDK for JavaScript does not provide a UMD bundle.

If you require UMD support, you can:

  • Use an earlier version of the SDK for JavaScript, such as 3.4.

  • Clone the repository with the latest source code and configure it locally to provide UMD support.

    Support for CommonJS (CJS) and ES Modules (ESM) is not affected and still provided in SDK for JavaScript 4.0.0
Updated Policy types

Updated policy types so that a PolicyRequirement array is output from failedPolicies.

Removed duplicate modules

Removed the FRUI and Event modules from the SDK for JavaScript repository.

These modules were incorrectly duplicated from the forgerock-javascript-sdk-ui repository.

Copyright © 2010-2023 ForgeRock, all rights reserved.