class AzureAuthentication extends AuthenticationHook

Constants

HOOK_PREFIX

Properties

Controller $mod

Instance providing the hook

from  BaseHook
array $_hook_info

Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => ""

from  BaseHook
protected string $name

Name of authentication method

from  AuthenticationHook
protected string $description

Short description of authentication method

from  AuthenticationHook
protected int $ttl from  AuthenticationHook
protected $auth_title

Methods

afterLogin()

No description

bool
authenticate_user(string $userid, string $password)

User authentication is wrapped for Auth Hooks

mixed
getAuthConfig(string $config_var)

Return configuration variable for auth method

getAuthHook(string $hook_identifier)

Load Auth Method Hook without Access Check

string
getAuthID()

Get internal Auth ID

array
getConfigurationFDL()

No description

string
getHookDescription()

No description

from  BaseHook
string
getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

from  BaseHook
array
getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

from  BaseHook
string
getHookInstance()

No description

from  BaseHook
string
getHookName()

No description

from  BaseHook
string
getHookTitle()

No description

from  BaseHook
getObject()

No description

from  BaseHook
int
getSessionTTL()

No description

array
get_module_info()

Return Auth Method information as keyed array [name, description, config]

array
get_user_details()

No description

bool
isAvailable()

Show this authentication method if installed, even if its not configured yet

login($login, string $password = null)

No description

void
logout()

No description

void
setName(mixed $name)

No description

Details

at line 120
afterLogin()

No description

Exceptions

IdentityProviderException
Exception

in AuthenticationHook at line 72
final bool authenticate_user(string $userid, string $password)

User authentication is wrapped for Auth Hooks

Parameters

string $userid

Username as entered by user

string $password

Password as enetered by user

Return Value

bool

Returns true of authentication is valid

Exceptions

AuthenticationException

in AuthenticationHook at line 118
final protected mixed getAuthConfig(string $config_var)

Return configuration variable for auth method

Parameters

string $config_var

Return Value

mixed

in AuthenticationHook at line 50
final static AuthenticationHook getAuthHook(string $hook_identifier)

Load Auth Method Hook without Access Check

Parameters

string $hook_identifier

Return Value

AuthenticationHook

Exceptions

Exception

in AuthenticationHook at line 128
final string getAuthID()

Get internal Auth ID

Return Value

string

at line 221
array getConfigurationFDL()

No description

Return Value

array

[ 'configoption' => [ 'type' => 'radio', 'label' => ("Choose a pill"), 'values' => array('b' => ("Blue"), 'r' => ("Red")) ] ]

Exceptions

Exception

in BaseHook at line 76
string getHookDescription()

No description

Return Value

string

in BaseHook at line 55
string getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

Return Value

string

in BaseHook at line 45
array getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

Parameters

bool $key

Return Value

array

in BaseHook at line 69
string getHookInstance()

No description

Return Value

string

in BaseHook at line 62
string getHookName()

No description

Return Value

string

in BaseHook at line 83
string getHookTitle()

No description

Return Value

string

in BaseHook at line 88
getObject()

No description

in AuthenticationHook at line 59
int getSessionTTL()

No description

Return Value

int

Time in seconds until session can/should be considered expired

in AuthenticationHook at line 93
final array get_module_info()

Return Auth Method information as keyed array [name, description, config]

Return Value

array

in AuthenticationHook at line 81
final array get_user_details()

No description

Return Value

array

Returns an array containing all user information

at line 154
bool isAvailable()

Show this authentication method if installed, even if its not configured yet

Return Value

bool

at line 26
UserDetails login($login, string $password = null)

No description

Parameters

$login
string $password

Password entered in form (if applicable)

Return Value

UserDetails

Exceptions

Exception

at line 139
void logout()

No description

Return Value

void

in AuthenticationHook at line 16
void setName(mixed $name)

No description

Parameters

mixed $name

Return Value

void