SymfonyWorld Online 2021 Summer Edition
June 17 – 18, 2021
SymfonyWorld Online 2021 Winter Edition
December 9 – 10, 2021
  1. Home
  2. Documentation
  3. Security
  4. How to Build a JSON Authentication Endpoint
WARNING:

You are browsing the documentation for Symfony 4.0 which is not maintained anymore.

Consider upgrading your projects to Symfony 5.3.

How to Build a JSON Authentication Endpoint

4.0 version
Maintained
4.4 5.2 5.3 current 5.4 dev 6.0
Unmaintained
3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1

How to Build a JSON Authentication Endpoint

In this entry, you’ll build a JSON endpoint to log in your users. Of course, when the user logs in, you can load your users from anywhere - like the database. See B) Configuring how Users are Loaded for details.

First, enable the JSON login under your firewall:

  • YAML
    1
2
3
4
5
6
7
8
9
    # config/packages/security.yaml
security:
    # ...

    firewalls:
        main:
            anonymous: ~
            json_login:
                check_path: /login
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    <!-- config/packages/security.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<srv:container xmlns="http://symfony.com/schema/dic/security"
    xmlns:srv="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        http://symfony.com/schema/dic/services/services-1.0.xsd">

    <config>
        <firewall name="main">
            <anonymous />
            <json-login check-path="/login" />
        </firewall>
    </config>
</srv:container>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    // config/packages/security.php
$container->loadFromExtension('security', array(
    'firewalls' => array(
        'main' => array(
            'anonymous'  => null,
            'json_login' => array(
                'check_path' => '/login',
            ),
        ),
    ),
));

Tip

The check_path can also be a route name (but cannot have mandatory wildcards - e.g. /login/{foo} where foo has no default value).

Now, when a request is made to the /login URL, the security system initiates the authentication process. You just need to configure a route matching this path:

  • Annotations
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    // src/Controller/SecurityController.php

// ...
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;

class SecurityController extends Controller
{
    /**
     * @Route("/login", name="login")
     */
    public function login(Request $request)
    {
    }
}
  • YAML
    1
2
3
4
    # config/routes.yaml
login:
    path:       /login
    controller: App\Controller\SecurityController::login
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    <!-- config/routes.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        http://symfony.com/schema/routing/routing-1.0.xsd">

    <route id="login" path="/login">
        <default key="_controller">App\Controller\SecurityController::login</default>
    </route>
</routes>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
    // config/routes.php
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;

$routes = new RouteCollection();
$routes->add('login', new Route('/login', array(
    '_controller' => 'App\Controller\SecurityController::login',
)));

return $routes;

Don’t let this empty controller confuse you. When you submit a POST request to the /login URL with the following JSON document as the body, the security system intercepts the requests. It takes care of authenticating the user with the submitted username and password or triggers an error in case the authentication process fails:

1
2
3
4
{
    "username": "dunglas",
    "password": "MyPassword"
}

If the JSON document has a different structure, you can specify the path to access the username and password properties using the username_path and password_path keys (they default respectively to username and password). For example, if the JSON document has the following structure:

1
2
3
4
5
6
7
8
{
    "security": {
        "credentials": {
            "login": "dunglas",
            "password": "MyPassword"
        }
    }
}

The security configuration should be:

  • YAML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    # config/packages/security.yaml
security:
    # ...

    firewalls:
        main:
            anonymous: ~
            json_login:
                check_path:    login
                username_path: security.credentials.login
                password_path: security.credentials.password
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
    <!-- config/packages/security.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<srv:container xmlns="http://symfony.com/schema/dic/security"
    xmlns:srv="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        http://symfony.com/schema/dic/services/services-1.0.xsd">

    <config>
        <firewall name="main">
            <anonymous />
            <json-login check-path="login"
                        username-path="security.credentials.login"
                        password-path="security.credentials.password" />
        </firewall>
    </config>
</srv:container>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    // config/packages/security.php
$container->loadFromExtension('security', array(
    'firewalls' => array(
        'main' => array(
            'anonymous'  => null,
            'json_login' => array(
                'check_path' => 'login',
                'username_path' => 'security.credentials.login',
                'password_path' => 'security.credentials.password',
            ),
        ),
    ),
));

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.