Skip to content

migrate.md

Latest commit

 

History

History
82 lines (64 loc) · 3.54 KB

migrate.md

File metadata and controls

82 lines (64 loc) · 3.54 KB

Migrating from okta-oidc-android

There are many reasons to upgrade from okta-oidc-android!

Installation

Add the Legacy Token Migration dependency to your build.gradle file:

implementation('com.okta.kotlin:legacy-token-migration')

Configuration

Applications migrating tokens will require code to configure both the legacy SessionClient as well as the new Credential. See README.md for configuring Auth Foundation.

Token Migration

Once your application is configured, use the LegacyTokenMigration.migrate method to migrate your tokens.

import android.content.Context
import com.okta.authfoundation.credential.Credential
import com.okta.legacytokenmigration.LegacyTokenMigration
import com.okta.oidc.clients.sessions.SessionClient

val context: Context = TODO("Supplied by the developer.")
val sessionClient: SessionClient = TODO("Supplied by the developer.")

when (val result = LegacyTokenMigration.migrate(context, sessionClient)) {
    is LegacyTokenMigration.Result.Error -> TODO("An error occurred: ${result.exception}")
    LegacyTokenMigration.Result.MissingLegacyToken -> TODO()
    is LegacyTokenMigration.Result.PreviouslyMigrated -> {
        TODO("Contains ${result.tokenId} for referencing stored token in CredentialDataSource")
        // Optionally set this as default Credential as follows
        Credential.with(result.tokenId())?.let { Credential.setDefaultCredential(it) }
    }
    is LegacyTokenMigration.Result.SuccessfullyMigrated -> {
        TODO("Contains ${result.tokenId} for referencing stored token in CredentialDataSource")
        // Optionally set this as default Credential as follows
        Credential.with(result.tokenId())?.let { Credential.setDefaultCredential(it) }
    }
}

Session client is often accessed via webAuthClient.sessionClient.

Update legacy configuration

In order for the user to get automatically redirected to the correct activity without a prompt, update the legacy configuration to use a legacy appAuthRedirectScheme.

android {
  defaultConfig {
    manifestPlaceholders = [
      "webAuthenticationRedirectScheme": "<your_redirect_scheme>",
      "appAuthRedirectScheme": "<your_redirect_scheme>.legacy",
    ]
  }
}

Use Credential

Credential replaces SessionClient, remove usages of SessionClient in your application. See all available methods here: Credential.

Use WebAuthentication

WebAuthentication replaces WebAuthClient, remove usages of WebAuthClient in your application. See all available methods here: WebAuthentication.

Use SessionTokenFlow

If you're using the legacy Authn APIs to do "custom authentication", you will need to use SessionTokenFlow which replaces authClient.signIn. See associated docs here: SessionTokenFlow. There is a sample using the flow available here: session-token-sample.

Sample

There's a sample demonstrating migration in the legacy-token-migration-sample directory.