Access Tokens for the Management API
Mobile + API: Auth0 Configuration
In this section we will review all the configurations we need to apply at the Auth0 Dashboard.
Create the API
Click on the APIs menu option on the left, and click the Create API button.
You will be required to supply the following details for your API:
- Name: a friendly name for the API. Does not affect any functionality.
- Identifier: a unique identifier for the API. We recommend using a URL but note that this doesn't have to be a publicly available URL, Auth0 will not call your API at all. This value cannot be modified afterwards.
- Signing Algorithm: the algorithm to sign the tokens with. The available values are
RS256. When selecting RS256 the token will be signed with the tenant's private key. To learn more about signing algorithms, see Signing Algorithms.
Fill in the required information and click the Create button.
When you create an API you have to select the algorithm your tokens will be signed with. The signature is used to verify that the sender of the JWT is who it says it is and to ensure that the message wasn't changed along the way.
To create the signature part you have to take the encoded header, the encoded payload, a secret, the algorithm specified in the header, and sign that. That algorithm, which is part of the JWT header, is the one you select for your API:
- RS256 is an asymmetric algorithm which means that there are two keys: one public and one private (secret). Auth0 has the secret key, which is used to generate the signature, and the consumer of the JWT has the public key, which is used to validate the signature.
- HS256 is a symmetric algorithm which means that there is only one secret key, shared between the two parties. The same key is used both to generate the signature and to validate it. Special care should be taken in order for the key to remain confidential.
The most secure practice, and our recommendation, is to use RS256. Some of the reasons are:
- With RS256 you are sure that only the holder of the private key (Auth0) can sign tokens, while anyone can check if the token is valid using the public key.
- Under HS256, If the private key is compromised you would have to re-deploy the API with the new secret. With RS256 you can request a token that is valid for multiple audiences.
- With RS256 you can implement key rotation without having to re-deploy the API with the new secret.
Configure the Permissions
Once the application has been created you will need to configure the Permissions which applications can request during authorization.
In the settings for your API, go to the Permissions tab. In this section you can add all four of the scopes which were discussed before, namely
Create the Application
There are four application types in Auth0: Native App (used by mobile or desktop apps), Single-Page Web App, Regular Web App, and Machine to Machine App (used by CLIs, Daemons, or services running on your backend). For this scenario we want to create a new Application for our mobile application, hence we will use Native as the application type.
Set a name for your Application (we will use
Timesheets Mobile) and select
Native App as the type.
You will need to ensure that the Authorization Extension is installed for your tenant. You can refer to the Authorization Extension documentation for details on how to do this.
You will need to define Permissions which correlates with the scopes you have already defined. In the Authorization Extension, click the Permissions tab, and then click on the Create Permission button. In the dialog, capture the details for each permission. Ensure that the name of the permission is exactly the same as the corresponding scope:
Proceed to create the permissions for all the remaining scopes:
Head over to the Roles tab and create two JSON Web Token (JWT)Roles. Click the Create Role button and select the Timesheets SPA application. Give the Role a name and description of Employee, and select the
read:timesheets permissions. Click on Save.
Next, follow the same process to create a Manager role, and ensure that you have selected all the permissions:
Assign Users to Roles
You will need to assign all users to either the Manager or the User role. You can do this by going to the Users tab in the Authorization Extension and selecting a user. On the user information screen, go to the Roles tab. You can add a role to the user by clicking the Add Role to User button, and selecting the appropriate role for the user.
You will also need to ensure that the Rule for the Authorization Extension is published. You can do this by clicking on your user avatar in to top right of the Authorization Extension, and selecting the Configuration option:
Ensure that you have enabled Permissions and then click the Publish Rule button:
Create a Rule to validate token scopes
The final step in this process is to create a Rule which will validate that the scopes contained in an Access Token is valid based on the permissions assigned to the user. Any scopes which are not valid for a user should be removed from the Access Token.
In your Auth0 Dashboard, go to the Rules tab. You should see the Rule created by the Authorization Extension:
Click on the Create Rule button and select the Empty Rule template. You can give the Rule a name, such as Access Token Scopes, and then specify the following code for the Rule:
The code above will ensure that all Access Tokens will only contain the scopes which are valid according to a user's permissions. Once you are done you can click on the Save button.
Rules execute in the order they are displayed on the Rules page, so ensure that the new rule you created is positioned below the rule for the Authorization Extension, so it executes after the Authorization Extension rule: