mezpahlan/forgerock-android-sdk

ForgeRock SDK for Android

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 21+
- Android 5.0 (Lollipop), 6.0 (Marshmallow), 7.0 (Nougat), 8.0 (Oreo), 9.0 (Pie), 10.0

Installation

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

Getting Started

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

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

Clone this repo:

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

Open the Android SDK project in Android Studio.
Open /app/src/main/res/values/strings.xml and edit the values to match your AM instance.
On the Run menu, click Run 'app'.

Documentation

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

Introducting the SDK Features
Preparing AM for use with the SDKS
API Reference documentation

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

ForgeRock does not warrant or guarantee the individual success developers may have in implementing the code on their development platforms or in production configurations.

ForgeRock does not warrant, guarantee or make any representations regarding the use, results of use, accuracy, timeliness or completeness of any data or information relating to this code.

ForgeRock disclaims all warranties, expressed or implied, and in particular, disclaims all warranties of merchantability, and warranties related to the code, or any service or software related thereto.

ForgeRock shall not be liable for any direct, indirect or consequential damages or costs of any type arising out of any action taken by you or others related to the code.

License

This project is licensed under the MIT License - see the LICENSE file for details

mezpahlan / forgerock-android-sdk