Skip to content

Project Structure ​

The Okta Client JavaScript ecosystem consists of multiple libraries, each focusing on a specific area or API. There are four tiers of libraries:

Platform Agnostic ​

  1. Foundational: Foundational libraries upon which other libraries are built.
  2. Token Acquisition & API Clients: Libraries for interacting with spec-compliant OAuth2 Authorization Servers and other Okta REST APIs.

Platform Specific ​

  1. Platform: Libraries that build upon and extend tier 1 and 2 libraries, targeting specific platforms like browsers or Node.js.
  2. Framework: Libraries built for specific frameworks (such as React, Angular, or Express) to facilitate integration with the Okta Client ecosystem.

Tier 1: Foundation Libraries ​

  • @okta/auth-foundation – Defines foundational classes and interfaces. All other libraries within the project will have a dependency on auth-foundation.

Tier 2: Token Acquisition Libraries & API Clients ​

Token Acquisition ​

  • @okta/oauth2-flows – Implementations of OAuth2 authentication flows, such as Authorization Code Flow.

API Clients – Coming Soon ​

Tier 3: Platform Libraries ​

Browser ​

  • @okta/spa-platform – Platform implementations and extensions for browser environments.
  • @okta/react-native-platform – Platform implementations and extensions for React Native environments.
  • @okta/nodejs-platform - COMING SOON

Tier 4: Framework Libraries ​

Browser – Coming Soon ​