forgerock_authenticator - Dart API docs

Change Log · Support · Docs

The ForgeRock Authenticator Plugin enables you to build the power of the official ForgeRock Authenticator application into your own app with ease.

The Authenticator module supports:

Time-based one-time passwords (TOTP)
HMAC-based one-time password (HOTP)
Push notifications

This project is provided as a Flutter plugin, a specialized package that includes platform-specific implementation code and utilizes the Authenticator module of our native SDK for iOS and Android. It also includes the Authenticator app as a sample project to help demonstrate the SDK functionality. The sample contains most of the functionalities available on the official ForgeRock Authenticator app.

Requirements

ForgeRock Identity Platform
- Access Management (AM) 6.5.2
Android API level 23+
iOS 12 and above
Flutter SDK 2.10.x and above

Installation

dependencies:
    dependencies:
      forgerock_authenticator:^1.1.2

Getting Started

Android

To try out the ForgeRock Android SDK sample, perform these steps:

Setup an Access Management (AM) instance for OATH or Push.
Clone this repo
Open the Android project forgerock-authenticator/example/android in Android Studio.
Add your google-services.json to the app folder.
On the Run menu, click Run 'app'.

iOS

To try out the ForgeRock Authenticator iOS sample app, perform these steps:

Setup an Access Management (AM) instance for OATH or Push.
Clone this repo
Open the forgerock-authenticator/example/ios/Runner.xcworkspace file in Xcode.
Update the your XCode project with your settings (Bundle Identifier, Provisioning Profile, Certificates, ...)
Ensure the active scheme is "Runner", and then click the Run button.

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 BackStage, our customer support portal that provides one stop access to ForgeRock services.

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

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 ForgeRock on an “as is” basis, without warranty of any kind, to the fullest extent permitted by law. ForgeRock 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 ForgeRock 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. ForgeRock 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 ForgeRock resides or in which ForgeRock 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