On This Page
Library Versions
Okta publishes a number of officially-supported libraries and SDKs on GitHub (opens new window). These libraries follow a consistent versioning and release pattern, described here. Note that this is separate from how Okta's HTTP APIs are versioned and released.
You can see a list of all our library versions and their support status at the bottom of this page.
Semantic Versioning
All of our libraries and SDKs follow semantic versioning (opens new window). Library versions will always be major.minor.patch
- for example, 0.1.2
or 2.1.33
.
We will:
- Increase the patch version for bug fixes, security fixes, and code documentation. Backwards compatible; no breaking changes.
- Increase the minor version for new features and additions to the library's interface. Backwards compatible; no breaking changes.
- Increase the major version for breaking changes to the library's interface or breaking changes to behavior.
Version Lifecycle
Semantic versioning means that within a major version, you can safely apply minor and patch updates without your code breaking. The status of each major version series (for example, 1.x
or 2.x
) follows this lifecycle:
Beta
Beta versions are currently in development and are not ready for production use. While a library version is in beta, the code interface is not final and breaking changes could occur without warning.
New libraries (or new major versions of existing libraries) typically stay in beta for a period of time while we iterate on the design and get feedback from the community. When the library is ready for production, it will be marked as stable.
Stable
Stable version series are supported by Okta for use in production code. Semantic versioning means that a stable major version may get new features (minor updates) or bug fixes (patch updates), but no breaking changes.
Retiring
When a new major version of a library is released, the old major version series will be marked as retiring. Retiring libraries are supported by Okta for at least nine months. After this period of time, the version series will be officially retired (below).
For example, if version 2.0.0 of okta-sdk-foobar
is published in January, the 1.x series of okta-sdk-foobar
(any version starting 1) will be officially supported until at least September. The retirement dates will be posted in the library's readme or documentation.
Retired
Retired version series are no longer supported by Okta, and are no longer recommended for production use. Okta will not publish new features or bug fixes for retired versions, except for critical security fixes (at our discretion).
For example, after okta-sdk-foobar
version 1.x has a retiring period (of at least nine months), it is no longer supported. Customers and developers are encouraged to upgrade to 2.0.0 or later.
When in doubt, check GitHub! The library's readme will clearly state any versions that are retiring or have been retired.
Current Versions
This table lists the current (and historical) major versions of our open-source libraries and tools. The most up-to-date information is always available from the GitHub readme of a particular project.
Library | Version | Status |
---|---|---|
Sign-In Widget (opens new window) | 1.13.0 2.21.0 3.9.2 4.x | Retired Retired Retiring on 2021-02-01 Stable |
Auth.js (opens new window) | 1.x 2.x 3.x 4.x | Retired Retiring on 2020-09-30 Retiring on 2021-05-30 Stable |
Android AppAuth SDK (opens new window) | 0.2.4 | Retired |
Android OIDC (opens new window) | 1.0.1 | Stable |
Angular SDK (opens new window) | 0.1.0 1.x 2.x | Retired Retiring on 2020-12-10 Stable |
ASP.NET SDK (opens new window) | 1.x | Stable |
ASP.NET Core SDK (opens new window) | 1.x 3.x | Stable Stable |
JWT verifier for Go (opens new window) | 0.x | Beta |
OIDC iOS (opens new window) (formerly iOS AppAuth SDK) | 1.x 2.x 3.x | Retired Retired Stable |
iOS OktaJWT (opens new window) | 0.1.0 1.x | Retired Stable |
iOS authentication SDK (opens new window) | 0.1.0 | Beta |
Java management SDK (opens new window) | 0.0.x 1.x 2.x.x 3.x.x | Retired Retiring on 2021-04-07 Retiring on 2021-09-03 Stable |
Java authentication SDK (opens new window) | 1.x 2.x | Retiring on 2021-04-28 Stable |
JWT verifier for Java (opens new window) | 0.x | Stable |
Spring Boot Starter (opens new window) | 0.x.x 1.x.0 2.x | Retired Retiring on 2021-09-28 Stable |
.NET management SDK (opens new window) | 0.3.3 (opens new window) 1.x 2.x 3.x | Retired Retiring on 2020-12-27 Retiring on 2021-04-10 Stable |
.NET authentication SDK (opens new window) | 1.x 2.x | Retiring on 2021-03-29 Stable |
Node.js management SDK (opens new window) | 1.2.0 2.x 3.x 4.x | Retired Retiring on 2020-12-04 Retiring on 2021-04-08 Stable |
JWT verifier for Node.js (opens new window) | 0.x | Stable |
OpenID Connect middleware for Node.js (opens new window) | 1.x 2.x 3.x 4.x | Retired Retiring on 2020-10-10 Retiring on 2020-11-26 Stable |
PHP management SDK (opens new window) | 0.2.0 1.x | Retired Stable |
PowerShell Module (opens new window) | 1.0.2 | Retired |
JWT verifier for PHP (opens new window) | 0.x | Stable |
React SDK (opens new window) | 0.0.13 1.x 2.x 3.x | Retired Retiring on 2020-12-03 Retiring on 2020-12-25 Stable |
React Native SDK (opens new window) | 0.1.0 1.x | Retired Stable |
Vue SDK (opens new window) | 0.1.0 1.x 2.x | Retired Retiring on 2021-01-03 Stable |