Abstract Class yii\authclient\OAuth2

All Classes | Properties | Methods

Inheritance	yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component » yii\base\BaseObject
Implements	yii\authclient\ClientInterface, yii\base\Configurable
Subclasses	yii\authclient\OpenIdConnect, yii\authclient\clients\Facebook, yii\authclient\clients\GitHub, yii\authclient\clients\Google, yii\authclient\clients\GoogleHybrid, yii\authclient\clients\LinkedIn, yii\authclient\clients\Live, yii\authclient\clients\TwitterOAuth2, yii\authclient\clients\VKontakte, yii\authclient\clients\Yandex
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-authclient/blob/master/OAuth2.php

OAuth2 serves as a client for the OAuth 2 flow.

In oder to acquire access token perform following sequence:

use yii\authclient\OAuth2;

// assuming class MyAuthClient extends OAuth2
$oauthClient = new MyAuthClient();
$url = $oauthClient->buildAuthUrl(); // Build authorization URL
Yii::$app->getResponse()->redirect($url); // Redirect to authorization URL.
// After user returns at our site:
$code = Yii::$app->getRequest()->get('code');
$accessToken = $oauthClient->fetchAccessToken($code); // Get access token

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$accessToken	yii\authclient\OAuthToken	Auth token instance. Note that the type of this property differs in getter and setter. See getAccessToken() and setAccessToken() for details.	yii\authclient\BaseOAuth
$apiBaseUrl	string	API base URL.	yii\authclient\BaseOAuth
$authUrl	string	Authorize URL.	yii\authclient\BaseOAuth
$autoRefreshAccessToken	boolean	Whether to automatically perform 'refresh access token' request on expired access token.	yii\authclient\BaseOAuth
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component. This property is read-only.	yii\base\Component
$clientId	string	OAuth client ID.	yii\authclient\OAuth2
$clientSecret	string	OAuth client secret.	yii\authclient\OAuth2
$enablePkce	boolean	Whether to enable proof key for code exchange (PKCE) support and add a `code_challenge` and `code_verifier` to the auth request.	yii\authclient\OAuth2
$httpClient	yii\httpclient\Client	Internal HTTP client. Note that the type of this property differs in getter and setter. See getHttpClient() and setHttpClient() for details.	yii\authclient\BaseClient
$id	string	Service id.	yii\authclient\BaseClient
$name	string	Service name.	yii\authclient\BaseClient
$normalizeUserAttributeMap	array	Normalize user attribute map.	yii\authclient\BaseClient
$parametersToKeepInReturnUrl	array	List of the parameters to keep in default return url.	yii\authclient\BaseOAuth
$requestOptions	array	HTTP request options. This property is read-only.	yii\authclient\BaseClient
$returnUrl	string	Return URL.	yii\authclient\BaseOAuth
$scope	string	Auth request scope.	yii\authclient\BaseOAuth
$signatureMethod	yii\authclient\signature\BaseMethod	Signature method instance. Note that the type of this property differs in getter and setter. See getSignatureMethod() and setSignatureMethod() for details.	yii\authclient\BaseOAuth
$stateStorage	yii\authclient\StateStorageInterface	Stage storage. Note that the type of this property differs in getter and setter. See getStateStorage() and setStateStorage() for details.	yii\authclient\BaseClient
$title	string	Service title.	yii\authclient\BaseClient
$tokenUrl	string	Token request URL endpoint.	yii\authclient\OAuth2
$userAttributes	array	List of user attributes.	yii\authclient\BaseClient
$validateAuthState	boolean	Whether to use and validate auth 'state' parameter in authentication flow.	yii\authclient\OAuth2
$version	string	Protocol version.	yii\authclient\OAuth2
$viewOptions	array	View options in format: optionName => optionValue.	yii\authclient\BaseClient

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
api()	Performs request to the OAuth API returning response data.	yii\authclient\BaseOAuth
applyAccessTokenToRequest()	Applies access token to the HTTP request instance.	yii\authclient\OAuth2
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
authenticateClient()	Authenticate OAuth client directly at the provider without third party (user) involved, using 'client_credentials' grant type.	yii\authclient\OAuth2
authenticateUser()	Authenticates user directly by 'username/password' pair, using 'password' grant type.	yii\authclient\OAuth2
authenticateUserJwt()	Authenticates user directly using JSON Web Token (JWT).	yii\authclient\OAuth2
beforeApiRequestSend()	Handles yii\httpclient\Request::EVENT_BEFORE_SEND event.	yii\authclient\BaseOAuth
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
buildAuthUrl()	Composes user authorization URL.	yii\authclient\OAuth2
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
createApiRequest()	Creates an HTTP request for the API call.	yii\authclient\BaseOAuth
createRequest()	Creates HTTP request instance.	yii\authclient\BaseClient
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
fetchAccessToken()	Fetches access token from authorization code.	yii\authclient\OAuth2
getAccessToken()		yii\authclient\BaseOAuth
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getHttpClient()	Returns HTTP client.	yii\authclient\BaseClient
getId()		yii\authclient\ClientInterface
getName()		yii\authclient\ClientInterface
getNormalizeUserAttributeMap()		yii\authclient\BaseClient
getRequestOptions()		yii\authclient\BaseClient
getReturnUrl()		yii\authclient\BaseOAuth
getSignatureMethod()		yii\authclient\BaseOAuth
getStateStorage()		yii\authclient\BaseClient
getTitle()		yii\authclient\ClientInterface
getUserAttributes()		yii\authclient\ClientInterface
getViewOptions()		yii\authclient\ClientInterface
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the object.	yii\base\BaseObject
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
refreshAccessToken()	Gets new auth token to replace expired one.	yii\authclient\OAuth2
setAccessToken()	Sets access token to be used.	yii\authclient\BaseOAuth
setHttpClient()	Sets HTTP client to be used.	yii\authclient\BaseOAuth
setId()		yii\authclient\ClientInterface
setName()		yii\authclient\ClientInterface
setNormalizeUserAttributeMap()		yii\authclient\BaseClient
setRequestOptions()		yii\authclient\BaseClient
setReturnUrl()		yii\authclient\BaseOAuth
setSignatureMethod()	Set signature method to be used.	yii\authclient\BaseOAuth
setStateStorage()		yii\authclient\BaseClient
setTitle()		yii\authclient\ClientInterface
setUserAttributes()		yii\authclient\BaseClient
setViewOptions()		yii\authclient\BaseClient
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
applyClientCredentialsToRequest()	Applies client credentials (e.g. $clientId and $clientSecret) to the HTTP request instance.	yii\authclient\OAuth2
composeUrl()	Composes URL from base URL and GET params.	yii\authclient\BaseOAuth
createHttpClient()	Creates HTTP client instance from reference or configuration.	yii\authclient\BaseOAuth
createSignatureMethod()	Creates signature method instance from its configuration.	yii\authclient\BaseOAuth
createToken()	Creates token from its configuration.	yii\authclient\OAuth2
defaultName()	Generates service name.	yii\authclient\BaseClient
defaultNormalizeUserAttributeMap()	Returns the default $normalizeUserAttributeMap value.	yii\authclient\BaseClient
defaultRequestOptions()	Returns default HTTP request options.	yii\authclient\BaseOAuth
defaultReturnUrl()	Composes default $returnUrl value.	yii\authclient\BaseOAuth
defaultTitle()	Generates service title.	yii\authclient\BaseClient
defaultViewOptions()	Returns the default $viewOptions value.	yii\authclient\BaseClient
generateAuthState()	Generates the auth state value.	yii\authclient\OAuth2
getState()	Returns persistent state value.	yii\authclient\BaseClient
getStateKeyPrefix()	Returns session key prefix, which is used to store internal states.	yii\authclient\BaseClient
initUserAttributes()	Initializes authenticated user attributes.	yii\authclient\BaseClient
normalizeUserAttributes()	Normalize given user attributes according to $normalizeUserAttributeMap.	yii\authclient\BaseClient
removeState()	Removes persistent state value.	yii\authclient\BaseClient
restoreAccessToken()	Restores access token.	yii\authclient\BaseOAuth
saveAccessToken()	Saves token as persistent state.	yii\authclient\BaseOAuth
sendRequest()	Sends the given HTTP request, returning response data.	yii\authclient\BaseOAuth
setState()	Sets persistent state.	yii\authclient\BaseClient

Property Details

$clientId public property

OAuth client ID.

public string $clientId = null

$clientSecret public property

OAuth client secret.

public string $clientSecret = null

$enablePkce public property (available since version 2.2.10)

Whether to enable proof key for code exchange (PKCE) support and add a code_challenge and code_verifier to the auth request.

Method Details

applyAccessTokenToRequest() public method (available since version 2.1)

Applies access token to the HTTP request instance.

public void applyAccessTokenToRequest ( $request, $accessToken )
$request	yii\httpclient\Request	HTTP request instance.
$accessToken	yii\authclient\OAuthToken	Access token instance.

applyClientCredentialsToRequest() protected method (available since version 2.1.3)

Applies client credentials (e.g. $clientId and $clientSecret) to the HTTP request instance.

This method should be invoked before sending any HTTP request, which requires client credentials.

protected void applyClientCredentialsToRequest ( $request )
$request	yii\httpclient\Request	HTTP request instance.

authenticateClient() public method (available since version 2.1.0)

Authenticate OAuth client directly at the provider without third party (user) involved, using 'client_credentials' grant type.

public yii\authclient\OAuthToken authenticateClient ( $params = [] )
$params	array	Additional request params.
return	yii\authclient\OAuthToken	Access token.

authenticateUser() public method (available since version 2.1.0)

Authenticates user directly by 'username/password' pair, using 'password' grant type.

public yii\authclient\OAuthToken authenticateUser ( $username, $password, $params = [] )
$username	string	User name.
$password	string	User password.
$params	array	Additional request params.
return	yii\authclient\OAuthToken	Access token.

authenticateUserJwt() public method (available since version 2.1.3)

Authenticates user directly using JSON Web Token (JWT).

public yii\authclient\OAuthToken authenticateUserJwt ( $username, $signature = null, $options = [], $params = [] )
$username	string
$signature	yii\authclient\signature\BaseMethod\|array	Signature method or its array configuration. If empty - $signatureMethod will be used.
$options	array	Additional options. Valid options are: header: array, additional JWS header parameters. payload: array, additional JWS payload (message or claim-set) parameters. signatureKey: string, signature key to be used, if not set - $clientSecret will be used.
$params	array	Additional request params.
return	yii\authclient\OAuthToken	Access token.

buildAuthUrl() public method

Composes user authorization URL.

public string buildAuthUrl ( array $params = [] )
$params	array	Additional auth GET params.
return	string	Authorization URL.

createToken() protected method

Creates token from its configuration.

protected yii\authclient\OAuthToken createToken ( array $tokenConfig = [] )
$tokenConfig	array	Token configuration.
return	yii\authclient\OAuthToken	Token instance.

fetchAccessToken() public method

Fetches access token from authorization code.

public yii\authclient\OAuthToken fetchAccessToken ( $authCode, array $params = [] )
$authCode	string	Authorization code, usually comes at GET parameter 'code'.
$params	array	Additional request params.
return	yii\authclient\OAuthToken	Access token.
throws	yii\web\HttpException	on invalid auth state in case enableStateValidation is enabled.

generateAuthState() protected method (available since version 2.1)

Generates the auth state value.

protected string generateAuthState ( )
return	string	Auth state value.

refreshAccessToken() public method

Gets new auth token to replace expired one.

public yii\authclient\OAuthToken refreshAccessToken ( yii\authclient\OAuthToken $token )
$token	yii\authclient\OAuthToken	Expired auth token.
return	yii\authclient\OAuthToken	New auth token.