Which OAuth 2.0 flow should I use?
OAuth 2.0 supports several different grants. By grants we mean ways of retrieving an Access Token. Deciding which one is suited for your case depends mostly on your Client's type, but other parameters weigh in as well, like the level of trust for the Client, or the experience you want your users to have.
Follow this flow to identify the grant that best matches your case.
Quick refresher - OAuth 2.0 terminology
- Resource Owner: the entity that can grant access to a protected resource. Typically this is the end-user.
- Client: an application requesting access to a protected resource on behalf of the Resource Owner.
- Resource Server: the server hosting the protected resources. This is the API you want to access.
- Authorization Server: the server that authenticates the Resource Owner, and issues Access Tokens after getting proper authorization. In this case, Auth0.
- User Agent: the agent used by the Resource Owner to interact with the Client, for example a browser or a native application.
Is the Client the Resource Owner?
The first decision point is about whether the party that requires access to resources is a machine. In this case of machine to machine authorization, the Client is also the Resource Owner. No end-user authorization is needed in this case. An example is a cron job that uses an API to import information to a database. In this example the cron job is the Client and the Resource Owner since it holds the Client Id and Client Secret and uses them to get an Access Token from the Authorization Server.
If this case matches your needs, then for more information on how this flow works and how to implement it refer to Calling APIs from a service.
Is the Client a web app executing on the server?
If the Client is a regular web app executing on a server then the Authorization Code Grant is the flow you should use. Using this the Client can retrieve an Access Token and, optionally, a Refresh Token. It's considered the safest choice since the Access Token is passed directly to the web server hosting the Client, without going through the user's web browser and risk exposure.
If this case matches your needs, then for more information on how this flow works and how to implement it refer to Calling APIs from server-side web apps.
Is the Client absolutely trusted with user credentials?
This decision point may result to suggesting the Resource Owner Password Credentials Grant. In this flow the end-user is asked to fill in credentials (username/password) typically using an interactive form. This information is sent to the backend and from there to Auth0. It is therefore imperative that the Client is absolutely trusted with this information.
This grant should only be used when redirect-based flows (like the Authorization Code Grant) are not possible. If this is your case, then for more information on how this flow works and how to implement it refer to Call APIs from Highly Trusted Clients.
Is the Client a native app or a SPA?
For more information on how this flow works and how to implement it, refer to Call APIs from client-side web apps.
SPAs and Refresh Tokens
While SPAs cannot use Refresh Tokens, they can take advantage of other mechanics that provide the same function. A workaround to improve user experience is to use
prompt=none when you invoke the /authorize endpoint. This will not display the login dialog or the consent dialog. For more information on this, refer to Silent Authentication. In addition to that if you call
/authorize from a hidden iframe and extract the new Access Token from the parent frame, then the user will not see the redirects happening.
If the Client is a native app then the Authorization Code Grant using Proof Key for Code Exchange should be used. What this grant adds to Authorization Code Grant, is the concept of
code_verifier. When at first the client asks for an Authorization Code it generates a
code_verifier and its transformed value called
code_challenge is sent along with the request. A
code_challenge_method is also sent. Afterwards, when the client wants to exchange the Authorization Code for an Access Token, it also sends along the
code_verifier. The Authorization Server transforms this and if it matches the originally sent
code challenge it returns an Access Token.
For more information on how this flow works and how to implement it, refer to /api-auth/grant/authorization-code-pkce.