Login Programmatically

.. versionadded:: 6.2

The :class:`Symfony\\Bundle\\SecurityBundle\\Security\\Security` class

was introduced in Symfony 6.2. In previous Symfony versions this class was

defined in ``Symfony\Component\Security\Core\Security``.

Since Symfony 6.2, you can log in an user programmatically using the `login()` method of the

`Symfony\\Bundle\\SecurityBundle\\Security\\Security` helper.

.. code-block:: php

use Symfony\Bundle\SecurityBundle\Security\Security;

class ExampleController

{

public function __construct(private Security $security)

{

}

public function someMethod(): Response

{

$user = ... // Get the user to be authenticated

$this->security->login($user);

// Redirect the user to its account page for instance

// ...

}

}

The previous example only works if you have one authenticator in the firewall. If the firewall is not passed, it will

retrieved from the request. If the current request is not under any firewall an exception will be thrown.

You can also pass the authenticator on which the user will

be authenticated against. For built-in authenticators, you can pass an authenticator name like "form_login",

"http_basic"... For custom authenticators, you can pass the service id of the authenticator

(ie `App\\Security\\Authenticator\\ExampleAuthenticator`)

.. code-block:: php

use App\Security\Authenticator\ExampleAuthenticator;

use Symfony\Bundle\SecurityBundle\Security\Security;

class ExampleController

{

public function __construct(private Security $security)

{

}

public function someMethod(): Response

{

$user = ... // Get the user to be authenticated

// You can use the authenticator name for built-in authenticator (like "form_login", "http_basic"...)

$this->security->login($user, 'form_login');

// Or the service id of your custom authenticator

$this->security->login($user, ExampleAuthenticator::class);

// Redirect the user to its account page for instance

// ...

}

}

Previous examples retrieves the firewall name according to the current request. But you can also pass a firewall

name to be authenticated against.

.. code-block:: php

use App\Security\Authenticator\ExampleAuthenticator;

use Symfony\Bundle\SecurityBundle\Security\Security;

class ExampleController

{

public function __construct(private Security $security)

{

}

public function someMethod(): Response

{

$user = ... // Get the user to be authenticated

$this->security->login($user, 'form_login', 'another_firewall');

// Redirect the user to its account page for instance

// ...

}

}