Class Auth0Proxy
Manages authentication against the internal HRM user database.
-
hrm\user\proxy\AbstractProxy
-
hrm\user\proxy\Auth0Proxy
Namespace: hrm\
user\
proxy
Package: hrm
Located at user/proxy/Auth0Proxy.php
Methods summary
public
|
#
__construct( )
Auth0Proxy constructor.
No parameters are passed to the constructor.
Auth0Proxy constructor.
No parameters are passed to the constructor.
|
public
string
|
#
friendlyName( )
Return a friendly name for the proxy to be displayed in the ui.
Return a friendly name for the proxy to be displayed in the ui.
Returns
string 'auth0'.
|
public
boolean
|
#
authenticate( string $username, string $password )
Authenticates the User with given username and password against the
configured Auth0 application.
Authenticates the User with given username and password against the
configured Auth0 application.
Parameters
- $username
- Username for authentication.
- $password
- Plain password for authentication.
Returns
boolean True if authentication succeeded, false otherwise.
Throws
Exception Implement this function!
|
public
null|string
|
#
getEmailAddress( string $username )
Returns the group or groups the user with given username belongs to.
Returns the group or groups the user with given username belongs to.
Parameters
- $username
- Username for which to query the group(s).
Returns
null|string Group or Array of groups or NULL if not found.
Throws
Exception Implement this function!
|
public
string
|
#
getGroup( string $username )
Returns the group the user with given username belongs to.
Returns the group the user with given username belongs to.
Parameters
- $username
- Username for which to query the group.
Returns
string Group or "" if not found.
Throws
Exception Implement this function!
|