@@ -153,22 +153,25 @@ or there was something wrong (e.g. incorrect password). The authenticator
153
153
can define what happens in these cases:
154
154
155
155
``onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response ``
156
- If the user is authenticated, this method is called with the
157
- authenticated ``$token ``. This method can return a response (e.g.
158
- redirect the user to some page).
156
+ If authentication is successful, this method is called with the
157
+ authenticated ``$token ``.
159
158
160
- If ``null `` is returned, the request continues like normal (i.e. the
161
- controller matching the login route is called). This is useful for API
162
- routes where each route is protected by an API key header.
159
+ This method can return a response (e.g. redirect the user to some page).
160
+
161
+ If ``null `` is returned, the current request will continue (and the
162
+ user will be authenticated). This is useful for API routes where each
163
+ route is protected by an API key header.
163
164
164
165
``onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response ``
165
- If an ``AuthenticationException `` is thrown during authentication, the
166
- process fails and this method is called. This method can return a
167
- response (e.g. to return a 401 Unauthorized response in API routes).
166
+ If authentication failed (e. g. wrong username password), this method
167
+ is called with the ``AuthenticationException `` thrown.
168
+
169
+ This method can return a response (e.g. send a 401 Unauthorized in API
170
+ routes).
168
171
169
- If ``null `` is returned, the request continues like normal. This is
170
- useful for e.g. login forms, where the login controller is run again
171
- with the login errors.
172
+ If ``null `` is returned, the request continues (but the user will ** not **
173
+ be authenticated). This is useful for login forms, where the login
174
+ controller is run again with the login errors.
172
175
173
176
If you're using :ref: `login throttling <security-login-throttling >`,
174
177
you can check if ``$exception `` is an instance of
0 commit comments