ForgeRock SDK for Android

Change Log · Support · Docs

---

The ForgeRock Android SDK enables you to quickly integrate the ForgeRock Identity Platform into your Android apps.

Use the SDKs to leverage Intelligent Authentication in ForgeRock's Access Management (AM) product, to easily step through each stage of an authentication tree by using callbacks.

Requirements

• ForgeRock Identity Platform

  • Access Management (AM) 6.5.2+

• Android API level 23+

  • Android 6.0 (Marshmallow), 7.0 (Nougat), 8.0 (Oreo), 9.0 (Pie), 10.0, 11.0, 12.0, 13.0, 14.0, 15.0

Installation

dependencies {
    implementation 'org.forgerock:forgerock-auth:<version>'
}

Getting Started

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

1. Setup an Access Management (AM) instance, as described in the Documentation.

2. Clone this repo:

   git clone https://github.com/ForgeRock/forgerock-android-sdk.git
   

3. Open the Android SDK project in Android Studio.

4. Open /app/src/main/res/values/strings.xml and edit the values to match your AM instance.

5. On the Run menu, click Run 'app'.

Documentation

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

• Introducing the SDK Features
• Preparing AM for use with the SDKS

Build API Reference Documentation

You can build the API reference documentation, which uses Dokka to generate either Javadoc or HTML output.

HTML : ./gradlew clean dokkaHtmlMultiModule : View the output at build/api-reference/html/.

JavaDoc : ./gradlew clean dokkaJavadocCollector : View the output at build/api-reference/javadoc/.

TIP: Use the following command to build both HTML and JavaDoc:

./gradlew clean dokkaHtmlMultiModule dokkaJavadocCollector

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.

Be sure to check out our Coding Style and Guidelines page.

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

---

© Copyright 2020 ForgeRock AS. All Rights Reserved