Symfony API: Authorization
This tutorial demonstrates how to add authentication and authorization to a Symfony 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:
Validate Access Tokens
Protecting a Symfony API with Auth0 requires the jwt-auth-bundle package. Install it using composer.
Add the bundle to AppKernel.php
Add configuration values
Add your Auth0 domain and API audience to the
config.yml file located in
Set up the User and UserProvider
UserProvider must implement the
/source/AppBundle/Security/A0UserProvider). This class should implement two methods:
loadUserByJWT: receives the decoded JWT Access Token and returns a User.
getAnonymousUser: returns an anonymous user that represents an unauthenticated one (usually represented by the role
Provide configuration for the
UserProvider in the
services.yml file located in
Set up the SecurityProvider
security.yml file located in
app/config such that it contains the following:
- The secured area that you want to authenticate using an Access Token
access_controlsection with the roles needed for each route
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
With this configuration in place, only calls that include Access Tokens which have a scope of
read:messages will be allowed to access this endpoint.