How to Build a JSON Authentication Endpoint

Version: 4.3
Edit this page

Warning: You are browsing the documentation for version 4.3 which is not maintained anymore.

If some of your projects are still using this version, consider upgrading.

How to Build a JSON Authentication Endpoint

In this entry, you'll build a JSON endpoint to log in your users. When the user logs in, you can load your users from anywhere - like the database. See Security for details.

First, enable the JSON login under your firewall:

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

    firewalls:
        main:
            anonymous: ~
            json_login:
                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).

The next step is to configure a route in your app matching this path:

  • Annotations
  • YAML
  • XML
  • PHP 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// src/Controller/SecurityController.php

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

class SecurityController extends AbstractController
{
    /**
     * @Route("/login", name="login", methods={"POST"})
     */
    public function login(Request $request)
    {
        $user = $this->getUser();

        return $this->json([
            'username' => $user->getUsername(),
            'roles' => $user->getRoles(),
        ]);
    }
}

Now, when you make a POST request, with the header Content-Type: application/json, to the /login URL with the following JSON document as the body, the security system intercepts the request and initiates the authentication process:

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

Symfony takes care of authenticating the user with the submitted username and password or triggers an error in case the authentication process fails. If the authentication is successful, the controller defined earlier will be executed.

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
  • XML
  • PHP 
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
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.