class BasicAuthenticationEntryPoint implements AuthenticationEntryPointInterface

BasicAuthenticationEntryPoint starts an HTTP Basic authentication.

Methods

__construct($realmName)

No description

start(Request $request, AuthenticationException $authException = null)

Returns a response that directs the user to authenticate.

Details

at line 27
__construct($realmName)

Parameters

$realmName

at line 35
Response start(Request $request, AuthenticationException $authException = null)

Returns a response that directs the user to authenticate.

This is called when an anonymous request accesses a resource that requires authentication. The job of this method is to return some response that "helps" the user start into the authentication process.

Examples:

  • For a form login, you might redirect to the login page

    return new RedirectResponse('/login');

  • For an API token authentication system, you return a 401 response

    return new Response('Auth header required', 401);

Parameters

Request $request The request that resulted in an AuthenticationException
AuthenticationException $authException The exception that started the authentication process

Return Value

Response