Documentation

TwoFactorAuth extends BaseAction
in package
Uses LoginHistory

Webservice standard container - Users two factor authentication action class.

Table of Contents

$allowedHeaders  : array<string|int, mixed>
$allowedMethod  : array<string|int, string>
$controller  : Controller
$responseType  : string
$userData  : array<string|int, mixed>
checkAction()  : void
Check called action.
delete()  : bool
Delete record.
get()  : array<string|int, mixed>
Get two factor authentication details.
getLanguage()  : string
Get current language.
getParentCrmId()  : int|null
Get parent record.
getPermissionType()  : int
Get permission type.
getUserCrmId()  : int
Get crmid for portal user.
getUserData()  : mixed
Get user data and session data.
getUserStorageId()  : int
Get user storage ID.
post()  : array<string|int, mixed>
Post method.
preProcess()  : mixed
Pre process function.
setAllUserData()  : void
Set user data.
setUserData()  : void
Set user data.
updateSession()  : void
Update user session.
updateUser()  : void
Update user data.
checkLifetimeSession()  : void
Check lifetime user session.
checkPermission()  : void
Check permission to method.
checkPermissionToModule()  : void
Check permission to module.
loadSession()  : void
Load user session data .
saveLoginHistory()  : void
Function to store the login history.

Properties

$allowedHeaders

public array<string|int, mixed> $allowedHeaders = []

Allowed headers

$allowedMethod

public array<string|int, string> $allowedMethod = ['GET', 'POST', 'DELETE']

Allowed methods

$responseType

public string $responseType = 'data'

Response data type.

$userData

private array<string|int, mixed> $userData = []

User data

Methods

checkAction()

Check called action.

public checkAction() : void
Tags
throws
Exception
Return values
void —

delete()

Delete record.

public delete() : bool
Tags
OA\Delete

( path="/webservice/WebserviceStandard/Users/TwoFactorAuth", summary="Disable 2FA", description="Disable two factor authentication", tags={"Users"}, security={{"basicAuth" : }, "ApiKeyAuth" : }, "token" : }}}, @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true), @OA\Response( response=200, description="Disable two factor authentication response", @OA\JsonContent(ref="#/components/schemas/Users_Delete_TwoFactorAuth_Response"), @OA\XmlContent(ref="#/components/schemas/Users_Delete_TwoFactorAuth_Response"), ), @OA\Response( response=405, description="Invalid method", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception") ), @OA\Response( response=500, description="Two-factor authentication has not been enabled", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception") ), ),

OA\Schema

( schema="Users_Delete_TwoFactorAuth_Response", title="Users module - Disable two factor authentication", description="Disable two factor authentication response", type="object", @OA\Property( property="status", description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success, 0 - error", enum={0, 1}, type="integer", ), @OA\Property( property="result", description="Status of successful", type="boolean", ), ),

Return values
bool —

get()

Get two factor authentication details.

public get() : array<string|int, mixed>
Tags
OA\Get

( path="/webservice/WebserviceStandard/Users/TwoFactorAuth", summary="2FA details", description="Get two factor authentication details", tags={"Users"}, security={{"basicAuth" : }, "ApiKeyAuth" : }, "token" : }}}, @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true), @OA\Response( response=200, description="Authentication secret details", @OA\JsonContent(ref="#/components/schemas/Users_Get_TwoFactorAuth_Response"), @OA\XmlContent(ref="#/components/schemas/Users_Get_TwoFactorAuth_Response"), ), @OA\Response( response=405, description="Invalid method", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception") ), @OA\Response( response=500, description="Two-factor authentication has not been enabled", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception") ), ),

OA\Schema

( schema="Users_Get_TwoFactorAuth_Response", title="Users module - Authentication secret details", type="object", required={"status", "result"}, @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"), @OA\Property( property="result", title="Content of responses from a given method", type="object", required={"authMethods", "secretKey"}, @OA\Property(property="authMethods", type="string", example="TOTP"), @OA\Property(property="secretKey", type="string", example="LJUJWCOEGUKP6WS2"), ), ),

Return values
array<string|int, mixed> —

getLanguage()

Get current language.

public getLanguage() : string
Return values
string —

getParentCrmId()

Get parent record.

public getParentCrmId() : int|null
Tags
throws
Exception
Return values
int|null —

getPermissionType()

Get permission type.

public getPermissionType() : int
Return values
int —

getUserCrmId()

Get crmid for portal user.

public getUserCrmId() : int
Return values
int —

getUserData()

Get user data and session data.

public getUserData(string $key[, string $param = '' ]) : mixed
Parameters
$key : string
$param : string = ''
Return values
mixed —

getUserStorageId()

Get user storage ID.

public getUserStorageId() : int
Return values
int —

post()

Post method.

public post() : array<string|int, mixed>
Tags
throws
Exception
OA\Post

( path="/webservice/WebserviceStandard/Users/TwoFactorAuth", summary="Activate 2FA", description="Activate two factor authentication", tags={"Users"}, security={{"basicAuth" : }, "ApiKeyAuth" : }, "token" : }}}, @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true), @OA\Response( response=200, description="Access details", @OA\JsonContent(ref="#/components/schemas/Users_post_TwoFactorAuth_Response"), @OA\XmlContent(ref="#/components/schemas/Users_post_TwoFactorAuth_Response") ), @OA\Response( response=405, description="Invalid method", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception") ), @OA\Response( response=500, description="Two-factor authentication has not been enabled OR A secret 2FA key has already been generated.", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception") ), ),

OA\Schema

( schema="Users_post_TwoFactorAuth_Response", title="Users module - Activate two factor authentication", description="Activate two factor authentication response body", type="object", @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"), @OA\Property( property="result", description="Content of responses from a given method", type="string", ), ),

Return values
array<string|int, mixed> —

preProcess()

Pre process function.

public preProcess() : mixed
Return values
mixed —

setAllUserData()

Set user data.

public setAllUserData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void —

setUserData()

Set user data.

public setUserData(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
Return values
void —

updateSession()

Update user session.

public updateSession([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

updateUser()

Update user data.

public updateUser([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

checkLifetimeSession()

Check lifetime user session.

protected checkLifetimeSession() : void
Tags
throws
Exception
Return values
void —

checkPermission()

Check permission to method.

protected checkPermission() : void
Tags
throws
Exception
Return values
void —

checkPermissionToModule()

Check permission to module.

protected checkPermissionToModule() : void
Return values
void —

loadSession()

Load user session data .

protected loadSession() : void
Tags
throws
Exception
Return values
void —

saveLoginHistory()

Function to store the login history.

protected saveLoginHistory(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results