OIDC Conformant Authentication Adoption Guide
As part of our efforts to improve security and standards-based interoperability, we are rolling out new features exclusively on authentication flows that strictly conform to specifications. The first of these features is API Authentication and Authorization, which is available today.
This guide details all the upcoming changes, some of which will be breaking, and provides suggestions on how to adapt your existing applications.
Who is this guide for?
This guide is meant for developers and IT admins who manage Auth0 integrations in their applications. If you are not familiar with how OAuth works at a basic level, we suggest reading our protocol overview.
If you are integrating Auth0 as a SAML or WS-Federation identity provider to your application (i.e. not through OIDC/OAuth), then you do not need to make any changes.
To make this guide accessible to everyone, any authentication flows will be described only through HTTP requests instead of in the context of any particular language or library's implementation. This is the similar to the descriptions and examples provided by the official OIDC specification.
All of the changes described in this guide apply to the OIDC Conformant Authentication Pipeline. This pipeline will be used if any of the following are true:
An authentication request was initiated with an
The client being used is flagged as OIDC Conformant (available at Dashboard > Clients > Settings > Show advanced settings > OAuth > OIDC Conformant flag).
If none of these conditions are met, the legacy authentication pipeline will be used, and everything will keep working as usual.
My application works just fine, why should I update?
Any new Auth0 features, examples and documentation moving forward will target only the OIDC-conformant pipeline. All Auth0 SDK versions that depend on the legacy pipeline are deprecated and will not receive updates for new features or non-critical security issues, and will eventually be discontinued.
The new features provided by the OIDC-conformant pipeline include:
- Create third-party clients for your APIs and display consent dialogs for authorization
- Restrict the user profile information provided to clients upon authentication
- OIDC Dynamic Client Registration
Is there a deadline to adopt these new features?
We understand that making changes to the core authentication logic of your application is not something that you want to do every day, and that any changes need to be thoroughly tested. Because of this, we are not setting a deadline to make changes at this time. Instead, both authentication pipelines (OIDC-conformant and legacy) will be usable until further notice.
All Auth0 documentation, SDKs, libraries and samples will eventually apply only to the OIDC-conformant pipeline. Because of this, we strongly recommend adoption even if you do not need to leverage any new features or functionality in the near future.
Compare differences between the two pipelines
- Calling your APIs with Auth0 tokens
- User consent and third-party clients
- Custom user profile claims and
- Single sign-on (SSO)
- Initiating authentication flows:
- Refresh tokens
- Delegation (deprecated)
- Passwordless authentication
- List of breaking changes for OIDC-conformant clients