Before you begin

We want you to have a smooth experience using the SecureAuth Mobile SDK library and to incorporate MFA capabilities easily. You can set up your Android and iOS native apps to use the SecureAuth Mobile SDK, but you must set them up separately. (In other words, the Mobile SDK does not support hybrid platforms.)

Additionally, the Mobile SDK currently supports only new customers and new deployments not currently using the SecureAuth Authenticate app.

The following are some important facts to understand before getting started.

Prerequisites

  • SecureAuth Mobile SDK (see SecureAuth compatibility guide for latest product release)

  • SecureAuth® Identity Platform (see SecureAuth compatibility guide for latest product release)

    The SecureAuth Mobile SDK is dependent on the services provided by the Identity Platform. Access to the mobile service is part of the Identity Platform license.

  • Check the SecureAuth status page if you'd like to see the API endpoint service listed there.

  • Ensure that you have a working Android or iOS mobile app to implement the SecureAuth Mobile SDK libraries

  • Operating systems and programming languages:

    Android: OS 10+, coded in Kotlin

    iOS: OS 13+, written in Swift and built with Xcode 12.0+; RXSwift library version 6.0+ set up in your application

  • iOS: If using push notification, acquire a push certificate for your application through Apple Developer Programs, available in the Apple Developer Portal.

  • Android:

    • If using push notification, set up Firebase cloud messaging for your application

    • You must use an Android compiler, such as Android Studio or a text editor

  • If using push-to-accept (push notification), you must integrate your push service with the Identity Platform.

    Your push service and the SecureAuth Identity Platform must communicate to provide essential information so that end users authenticate securely in your branded app. You'll need to configure services and certificates to ensure smooth communication. This can be a bit complicated; contact SecureAuth Support before you start.

  • Obtain the client ID

    Obtain credentials by contacting SecureAuth Support by email or telephone at support@secureauth.com or 1-866-859-1526.

Standards

  • JSON-based RESTful API

    API calls to the SecureAuth Mobile SDK use a new SecureAuth RESTful API endpoint

  • HTTP response codes and verbs

  • Token-based authentication

  • OAuth 2.0+ PKCE as the authentication protocol, with a more secure version than past frameworks

Assumptions

The information in these topics assumes that you:

  • Understand the basics of RESTful APIs and how they work

  • Decide if you need to set up Android SDK, iOS SDK, or both

Limitations

The following are the SecureAuth SDK limitations.

  • Android and iOS SDK: You must set up your own push service for your application.

  • Android and iOS SDK: SecureAuth provides the data objects, but developers are responsible for presenting the data on their app.

In this section: