HttpHeaderAuth

API reference › yii › filters › auth › HttpHeaderAuth

class	`yii\filters\auth\HttpHeaderAuth`
Extends	`AuthMethod` » `yii\base\ActionFilter` » `yii\base\Behavior` » `yii\base\BaseObject`
Implements	`AuthInterface`, `yii\base\Configurable`
Since	2.0.14
Source	`framework/filters/auth/HttpHeaderAuth.php`

1 subclass

HttpBearerAuth

HttpHeaderAuth is an action filter that supports HTTP authentication through HTTP Headers.

You may use HttpHeaderAuth by attaching it as a behavior to a controller or module, like the following:

public function behaviors()
{
    return [
        'basicAuth' => [
            'class' => \yii\filters\auth\HttpHeaderAuth::class,
        ],
    ];
}

The default implementation of HttpHeaderAuth uses the loginByAccessToken() method of the user application component and passes the value of the X-Api-Key header. This implementation is used for authenticating API clients.

Properties

Property	Type	Description	Defined by
`$except`	`array`	List of action IDs that this filter should not apply to. Default: `[]`.	`yii\base\ActionFilter`
`$header`	`string`	The HTTP header name Default: `'X-Api-Key'`.	`HttpHeaderAuth`
`$only`	`array`	List of action IDs that this filter should apply to. Default: `[]`.	`yii\base\ActionFilter`
`$optional`	`array`	List of action IDs that this filter will be applied to, but auth failure will not lead to error. Default: `[]`. Available since 2.0.7.	`AuthMethod`
`$owner`	`yii\base\T\|null`	The owner of this behavior Default: `null`.	`yii\base\Behavior`
`$pattern`	`string`	A pattern to use to extract the HTTP authentication value Default: `null`.	`HttpHeaderAuth`
`$request`	`yii\web\Request\|null`	The current request. Default: `null`.	`AuthMethod`
`$response`	`yii\web\Response\|null`	The response to be sent. Default: `null`.	`AuthMethod`
`$user`	`yii\web\User\|null`	The user object representing the user authentication status. Default: `null`.	`AuthMethod`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`afterAction()`	This method is invoked right after an action is executed.	`yii\base\ActionFilter`
`afterFilter()`		`yii\base\ActionFilter`
`attach()`	Attaches the behavior object to the component.	`yii\base\ActionFilter`
`authenticate()`	Authenticates the current user.	`HttpHeaderAuth`
`beforeAction()`	This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.	`AuthMethod`
`beforeFilter()`		`yii\base\ActionFilter`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`challenge()`	Generates challenges upon authentication failure.	`AuthMethod`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`detach()`	Detaches the behavior object from the component.	`yii\base\ActionFilter`
`events()`	Declares event handlers for the `$owner`’s events.	`yii\base\Behavior`
`handleFailure()`	Handles authentication failure.	`AuthMethod`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`
`getActionId()` protected	Returns an action ID by converting `Action::$uniqueId` into an ID relative to the module.	`yii\base\ActionFilter`
`isActive()` protected	Returns a value indicating whether the filter is active for the given action.	`yii\base\ActionFilter`
`isOptional()` protected	Checks, whether authentication is optional for the given action.	`AuthMethod`

Method details

authenticate()

public function authenticate(mixed $user, mixed $request, mixed $response): yii\web\IdentityInterface|null

Authenticates the current user.

Parameters

Parameter	Type	Description
`$user`	`mixed`
`$request`	`mixed`
`$response`	`mixed`

Returns

yii\web\IdentityInterface|null: The authenticated user identity. If authentication information is not provided, null will be returned.

Throws

yii\web\UnauthorizedHttpException: if authentication information is provided but is invalid.