Spring Security Java API: Authorization
This tutorial demonstrates how to add authorization to a Spring Security API. We recommend you to Log in to follow this quickstart with examples configured for your account.
I want to integrate with my app15 minutes
I want to explore a sample app2 minutes
Get a sample configured with your account settings or check it out on Github.
Configure Auth0 APIs
Create an API
In the APIs section of the Auth0 dashboard, click Create API. Provide a name and an identifier for your API, for example
https://quickstarts/api. You will use the identifier as an
audience later, when you are configuring the Access Token verification. For Signing Algorithm, select RS256.
By default, your API uses RS256 as the algorithm for signing tokens. Since RS256 uses a private/public keypair, it verifies the tokens against the public key for your Auth0 account. The public key is in the JSON Web Key Set (JWKS) format, and can be accessed here.
Scopes let you define which resources can be accessed by the user with a given Access Token. For example, you might choose to grant read access to the
messages resource if users have the manager access level, and a write access to that resource if they have the administrator access level.
You can add the required scopes in the Scopes tab of the Auth0 Dashboard's APIs section.
This example demonstrates:
Configure the Sample Project
The sample project has a
/src/main/resources/auth0.properties file which configures it to use the correct Auth0 Domain and API Identifier for your API. If you download the code from this page it will be automatically filled. If you use the example from Github, you will need to fill it yourself.
||The issuer of the JWT Token. Typically, this is your Auth0 domain with a
||The unique identifier for your API. If you are following the steps in this tutorial it would be
Validate Access Tokens
If you are using Maven, add the dependency to your
If you are using Gradle, add the dependency to the dependencies block:
Configure JSON Web Token signature algorithm
Configure your API to use the RS256 signing algorithm.
Protect API Endpoints
The routes shown below are available for the following requests:
GET /api/public: available for non-authenticated requests
GET /api/private: available for authenticated requests containing an Access Token with no additional scopes
GET /api/private-scoped: available for authenticated requests containing an Access Token with the
The example below shows how to implement secure API methods. In the
AppConfig class, add route matchers to the snippet. The
hasAuthority() method provides a way to specify the required scope for the resource.
Create the API Controller
Create a new class called
APIController to handle each request to the endpoints.
Next, in the
AppConfig.java file, configure which endpoints are secure and which are not.
To build and run the seed project, use the command: