Skip to content
This repository has been archived by the owner on Oct 19, 2022. It is now read-only.

Latest commit

 

History

History
55 lines (38 loc) · 4.19 KB

migrating.md

File metadata and controls

55 lines (38 loc) · 4.19 KB
Raw

Migrating from Stormpath to Okta

This document is intended to give you a high-level understanding of the steps required to migrate an application from Stormpath to Okta. For more information, see the Stormpath-Okta Customer FAQ.

⚠️ The Stormpath API will sunset on 2017-08-17 19:00 UTC (August 17, 2017 at noon PDT). At the very least, make sure you export your data before then!

Before you begin

  • Read the changelog for information on breaking changes.

Migration steps

  1. Create a test user in your existing system with a known password.

  2. Export your Stormpath data.

  3. Sign up for a new developer Okta organization, even if you already have an Okta organization. Signing up through this link will provision an Okta organization with features most similar to Stormpath.

    • Note: new Okta organizations are assigned URLs in the format dev-12345.oktapreview.com. These tenants are production-ready and similar to Stormpath tenants on api.stormpath.com. If your infrastructure was on the Stormpath Enterprise tier instead, let us know!

  4. Import your Stormpath data into Okta using the import tool.

  5. Upgrade the version of Stormpath.AspNet, Stormpath.AspNetCore, or Stormpath.Owin in your project to 4.0.0 or greater.

  6. Remove any references to Stormpath.SDK or the IClient interface. The Stormpath .NET SDK has been deprecated. Any code that was using the SDK will need to be refactored to use the Okta .NET SDK or Okta REST API. If you need help, let us know at [email protected].

  7. Update your application configuration:

    • You must provide these new configuration properties:

      • org (your Okta org URL, like https://dev-123456.oktapreview.com),
      • apiToken (an Okta API token),
      • application.id (the Okta application ID, which can be found in the URL of the Admin UI when editing the Application: /admin/app/oidc_client/instance/<appid>)

    • If you were using STORMPATH_* environment variables to set any configuration properties, you'll need to update them to OKTA_*.

    • Most of the remaining configuration can be left untouched. See the configuration breaking changes.

    • A minimal example configuration looks like:

    Configuration = new StormpathConfiguration
{
    Org = "https://dev-123456.oktapreview.com/",
    ApiToken = "my-api-token",
    Application = new OktaApplicationConfiguration()
    {
	Id = "abcd1234"
    }
}

  8. (Optional) If you used the Password Reset workflow in Stormpath, update the Okta Password Reset email template. You can copy the current template from the Stormpath Admin Console, and paste it into the Okta template found at Settings > Email & SMS > Forgot Password.

You'll want to use the ${recoveryToken} variable to create a link that points the user to the change password endpoint on your application, for example: http://localhost:3000/change?sptoken=${recoveryToken}. If the validator complains about ${resetPasswordLink} being missing, place it in an HTML comment: <!-- ${resetPasswordLink} -->

Also, read the note on password reset in the changelog.

  1. (Optional) If you used the Email Verification workflow in Stormpath, you'll need to use the SendVerificationEmailHandler in this library, plus an email service like SendGrid, to send your own verification email.

  2. Run your application with your configuration pointed to the new Okta organization that contains your imported data, and try logging in with the test user you created in step 1.

If you run into problems, please let us know at [email protected]. We'll be continually updating this library (and document) as needed to help make the migration process as smooth as possible.