Call APIs from Highly Trusted Applications
Highly trusted applications can use this flow to access APIs. 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.
You should use this flow only if the following apply:
- The application is absolutely trusted with the user's credentials. For Single-Page Applications and Native/Mobile Apps we recommend using web flows instead.
- Using a redirect-based flow is not possible. If this is not the case and redirects are possible in your application, you should use the Authorization Code Flow instead.
The Resource Owner Password Grant (defined in RFC 6749, section 4.3) can be used directly as an authorization grant to obtain an Access Token, and optionally a Refresh Token. This grant should only be used when there is a high degree of trust between the user and the application and when other authorization flows are not available.
This grant type can eliminate the need for the application to store the user credentials for future use, by exchanging the credentials with a long-lived Access Token or Refresh Token.
- The end user enters the credentials into the application.
- The application forwards the credentials to Auth0.
- Auth0 validates the information and returns an Access Token, and optionally a Refresh Token.
- The application can use the Access Token to call the API on behalf of the end user.
How to implement the flow
For details on how to implement this using Auth0, refer to Execute the Resource Owner Password Grant.
A extension grant that offers similar functionality with the Resource Owner Password Grant, including the ability to indicate a specific realm, is the
Realms allow you to keep separate user directories and specify which one to use to the token endpoint. For example, you may have an application where both employees and customers can log in but their credentials are kept in separate user directories. You can present a user interface with a dropdown containing
Customers as realms (which would be connections in Auth0 dashboard). The realm value, along with the username and password credentials, will be submitted to the token endpoint. Auth0 will use the realm value to determine which directory (connection) to use when verifying the password.
For more information on how to implement this extension grant refer to Executing a Resource Owner Password Grant > Realm Support.
Due to the implied trust in these grants (a user providing his or her password to an application), the Access Token returned will include all of the available scopes defined for the audience API. An application can request a restricted set of scopes by using the
scope parameter, or you can restrict the returned scopes by using a rule.
Rules will run for the Password Exchange (including the Password Realm extension grant). There are two key differences in the behavior of rules in these flows:
- Redirect rules won't work. If you try to do a redirect by specifying
context.redirectin your rule, the authentication flow will return an error.
If you wish to execute special logic unique to the Password exchange, you can look at the
context.protocol property in your rule. If the value is
oauth2-password, then the rule is running during the password exchange.
For details on how to implement this, refer to Execute the Resource Owner Password Grant: Customize the Tokens.
For details on how to implement multi-factor authentication, refer to Multi-factor Authentication and Resource Owner Password.