Class yii\authclient\clients\Live

All Classes | Properties | Methods

Inheritance	yii\authclient\clients\Live » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component » yii\base\BaseObject
Implements	yii\authclient\ClientInterface, yii\base\Configurable
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-authclient/blob/master/clients/Live.php

Live allows authentication via Microsoft Live OAuth.

In order to use Microsoft Live OAuth you must register your application at https://account.live.com/developers/applications

Example application configuration:

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'live' => [
                'class' => 'yii\authclient\clients\Live',
                'clientId' => 'live_client_id',
                'clientSecret' => 'live_client_secret',
            ],
        ],
    ]
    // ...
]

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$apiBaseUrl		{@inheritdoc}	yii\authclient\clients\Live
$authUrl		{@inheritdoc}	yii\authclient\clients\Live
$autoRefreshAccessToken	boolean	Whether to automatically perform 'refresh access token' request on expired access token.	yii\authclient\BaseOAuth
$clientId	string	OAuth client ID.	yii\authclient\OAuth2
$clientSecret	string	OAuth client secret.	yii\authclient\OAuth2
$parametersToKeepInReturnUrl	array	List of the parameters to keep in default return url.	yii\authclient\BaseOAuth
$scope	string	Auth request scope.	yii\authclient\BaseOAuth
$tokenUrl		{@inheritdoc}	yii\authclient\clients\Live
$validateAuthState	boolean	Whether to use and validate auth 'state' parameter in authentication flow.	yii\authclient\OAuth2
$version	string	Protocol version.	yii\authclient\BaseOAuth

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\BaseOAuth
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\BaseClient
getName()		yii\authclient\BaseClient
getNormalizeUserAttributeMap()		yii\authclient\BaseClient
getRequestOptions()		yii\authclient\BaseClient
getReturnUrl()		yii\authclient\BaseOAuth
getSignatureMethod()		yii\authclient\BaseOAuth
getStateStorage()		yii\authclient\BaseClient
getTitle()		yii\authclient\BaseClient
getUserAttributes()		yii\authclient\BaseClient
getViewOptions()		yii\authclient\BaseClient
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()	{@inheritdoc}	yii\authclient\clients\Live
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\BaseOAuth
setAccessToken()	Sets access token to be used.	yii\authclient\BaseOAuth
setHttpClient()	Sets HTTP client to be used.	yii\authclient\BaseClient
setId()		yii\authclient\BaseClient
setName()		yii\authclient\BaseClient
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\BaseClient
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\BaseClient
createSignatureMethod()	Creates signature method instance from its configuration.	yii\authclient\BaseOAuth
createToken()	Creates token from its configuration.	yii\authclient\BaseOAuth
defaultName()	{@inheritdoc}	yii\authclient\clients\Live
defaultNormalizeUserAttributeMap()	Returns the default \yii\authclient\normalizeUserAttributeMap value.	yii\authclient\BaseClient
defaultRequestOptions()	Returns default HTTP request options.	yii\authclient\BaseClient
defaultReturnUrl()	Composes default \yii\authclient\returnUrl value.	yii\authclient\BaseOAuth
defaultTitle()	{@inheritdoc}	yii\authclient\clients\Live
defaultViewOptions()	Returns the default \yii\authclient\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()	{@inheritdoc}	yii\authclient\clients\Live
normalizeUserAttributes()	Normalize given user attributes according to \yii\authclient\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

$apiBaseUrl public property

public $apiBaseUrl = 'https://apis.live.net/v5.0'

$authUrl public property

public $authUrl = 'https://login.live.com/oauth20_authorize.srf'

$tokenUrl public property

public $tokenUrl = 'https://login.live.com/oauth20_token.srf'

Method Details

defaultName() protected method

{@inheritdoc}

protected void defaultName ( )

defaultTitle() protected method

{@inheritdoc}

protected void defaultTitle ( )

init() public method

{@inheritdoc}

public void init ( )

initUserAttributes() protected method

{@inheritdoc}

protected void initUserAttributes ( )