Bitrix API

Auth

Table of Contents

Constants

AUTH_TYPE  = 'oauth'
CACHE_PREFIX  = "oauth_"
CACHE_TTL  = 3600
PARAM_LOCAL_USER  = 'LOCAL_USER'
PARAM_TZ_OFFSET  = 'TZ_OFFSET'

Methods

authorizeClient()  : mixed
get()  : mixed
getAuthKey()  : mixed
getStorage()  : AuthStorageInterface
onRestCheckAuth()  : mixed
setStorage()  : mixed
storeRegisteredAuth()  : mixed
updateTokenParameters()  : mixed

Constants

AUTH_TYPE

public mixed AUTH_TYPE = 'oauth'

CACHE_PREFIX

public mixed CACHE_PREFIX = "oauth_"

CACHE_TTL

public mixed CACHE_TTL = 3600

PARAM_LOCAL_USER

public mixed PARAM_LOCAL_USER = 'LOCAL_USER'

PARAM_TZ_OFFSET

public mixed PARAM_TZ_OFFSET = 'TZ_OFFSET'

Methods

authorizeClient()

public static authorizeClient(mixed $clientId, mixed $userId[, mixed $state = '' ]) : mixed

Use \Bitrix\Rest\Application::getAuthProvider()->authorizeClient()

Parameters
$clientId : mixed
$userId : mixed
$state : mixed = ''

get()

public static get(mixed $clientId, mixed $scope, mixed $additionalParams, mixed $userId) : mixed

Use \Bitrix\Rest\Application::getAuthProvider()->get()

Parameters
$clientId : mixed
$scope : mixed
$additionalParams : mixed
$userId : mixed

getAuthKey()

public static getAuthKey(array<string|int, mixed> $query) : mixed
Parameters
$query : array<string|int, mixed>

getStorage()

public static getStorage() : AuthStorageInterface
Return values
AuthStorageInterface

onRestCheckAuth()

public static onRestCheckAuth(array<string|int, mixed> $query, mixed $scope, mixed &$res) : mixed
Parameters
$query : array<string|int, mixed>
$scope : mixed
$res : mixed

setStorage()

public static setStorage(AuthStorageInterface $storage) : mixed
Parameters
$storage : AuthStorageInterface

storeRegisteredAuth()

public static storeRegisteredAuth(array<string|int, mixed> $tokenInfo) : mixed
Parameters
$tokenInfo : array<string|int, mixed>

updateTokenParameters()

public static updateTokenParameters(mixed $tokenInfo) : mixed
Parameters
$tokenInfo : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results