On this page
Add the Identity Engine SDK to your app
This guide explains how to add the Identity Engine SDK to your app. Complete this step before you upgrade your app's authentication use cases.
Note: After your Okta org is upgraded to Identity Engine, your app should still work as expected with no change in functionality. If you want to take advantage of Identity Engine features, upgrade your app to use Identity Engine SDK methods and authentication flows.
Learning outcomes
- Upgrade to the minimum SDK requirements.
- Add or upgrade to the Identity Engine SDK.
What you need
An Identity Engine-upgraded Okta org
Overview
After your Okta org is upgraded to Identity Engine, your next step is to add the Identity Engine SDK to your app. This step includes upgrading your app to meet the minimum software requirements. Except for changes related to upgrading and adding the Identity Engine SDK, there should be no other changes to your source code. This step ensures that you have the right version of the new Identity Engine SDK and that your app still works the same as it did before the upgrade.
The recommended steps to add the SDK to your app:
When to use this guide
Use this guide if you've completed the Okta Org upgrade to Identity Engine, your app's authentication flows use either the Authentication API or the Classic Engine SDKs, and you're ready to upgrade those flows to use the Identity Engine SDK.
Upgrade your app to the minimum requirements
Before you can add the SDK to your app, it must meet the following minimum requirements:
Add the SDK package to your app
Test your app
After you add the SDK, test your app. The type of tests, which may include unit and integration tests, depend on your testing process and methodologies specific to your organization. You may also elect to deploy the app to various environments during your testing. The goal is to ensure that the relatively simple addition of the Identity Engine SDK causes no changes to the app regarding functionality, performance, or interoperability with other apps. Specifically, you may want to ensure that your previous calls to the Classic Engine SDKs still work as expected.
To preview the Identity Engine SDK features and authentication flows, review the sample apps included in the SDK. For information on configuring and running the sample apps, see Run the sample apps and the use cases.