AuthenticationProviderChallengeInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Authentication/AuthenticationProviderChallengeInterface.php
  2. 8.9.x core/lib/Drupal/Core/Authentication/AuthenticationProviderChallengeInterface.php
  3. 11.x core/lib/Drupal/Core/Authentication/AuthenticationProviderChallengeInterface.php

Namespace

Drupal\Core\Authentication

File

core/lib/Drupal/Core/Authentication/AuthenticationProviderChallengeInterface.php

View source
<?php

namespace Drupal\Core\Authentication;

use Symfony\Component\HttpFoundation\Request;

/**
 * Generate a challenge when access is denied for unauthenticated users.
 *
 * On a 403 (access denied), if there are no credentials on the request, some
 * authentication methods (e.g. basic auth) require that a challenge is sent to
 * the client.
 */
interface AuthenticationProviderChallengeInterface {
    
    /**
     * Constructs an exception which is used to generate the challenge.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The request.
     * @param \Exception $previous
     *   The previous exception.
     *
     * @return \Symfony\Component\HttpKernel\Exception\HttpExceptionInterface|null
     *   An exception to be used in order to generate an authentication challenge.
     */
    public function challengeException(Request $request, \Exception $previous);

}

Interfaces

Title Deprecated Summary
AuthenticationProviderChallengeInterface Generate a challenge when access is denied for unauthenticated users.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.