Skip to content

Fix and improve JSON login docs #10467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions security/json_login_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@ path:
*/
public function loginAction(Request $request)
{
$user = $this->getUser();

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

Expand Down Expand Up @@ -117,11 +123,11 @@ path:

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:
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.
If the authentication is successful, the controller defined earlier will be executed.

.. code-block:: json

Expand Down