StudipAuthOIDC Class Reference

Inheritance diagram for StudipAuthOIDC:

Public Member Functions
	__construct ($config=[])
	verifyUsername ($username)
	getUser ()
	getUserDomains ()
	getUserData ($key)
	logout ()
Public Member Functions inherited from StudipAuthSSO
	getUser ()
	isAuthenticated ($username, $password)
	isUsedUsername ($username)
	logout ()
Public Member Functions inherited from StudipAuthAbstract
	__construct ($config=[])
	authenticateUser ($username, $password)
	getStudipUser ($username)
	doNewUserInit ($user)
	setUserDomains ($user)
	getUserDomains ()
	doDataMapping ($user)
	isMappedField ($name)
	verifyUsername ($username)
	isUsedUsername ($username)
	isAuthenticated ($username, $password)
	__isset ($offset)
	__set ($offset, $value)
	__get ($offset)
	__unset ($offset)

Data Fields
	$provider_url
	$client_id
	$client_secret
string	$redirect_uri = null
	$scopes = ['openid', 'email', 'profile']
Data Fields inherited from StudipAuthSSO
	$plugin_fullname
	$login_description
Data Fields inherited from StudipAuthAbstract
	$error_msg
	$is_new_user = false
array	$user_domains = null
bool	$sync_all_domains = true
	$user_data_mapping = null
	$plugin_name
	$error_head
	$show_login

Protected Member Functions
	getClient ()

Additional Inherited Members
Static Public Member Functions inherited from StudipAuthAbstract
static	getInstance ($plugin_name=false)
static	isSSOEnabled ()
static	isLoginEnabled ()
static	CheckAuthentication ($username, $password)
static	CheckUsername ($username)
static	CheckField ($field_name, $plugin_name)
static	CheckIPRange ()
static	CheckIPRangeV4 ($ip, $range)
static	CheckIPRangeV6 ($ip, $range)

Constructor & Destructor Documentation

__construct()

__construct

(

$config = []

)

Member Function Documentation

getClient()

getClient ( )

protected

Returns the configured OpenID Connect client.

getUser()

getUser

(

)

Return the current username of the pending authentication request.

getUserData()

getUserData

(

$key

)

Callback that can be used in user_data_mapping array.

See also

https://openid.net/specs/openid-connect-basic-1_0.html#StandardClaims

Parameters

string

$key

Returns

string parameter value (null if not set)

getUserDomains()

getUserDomains

(

)

Get the user domains to assign to the current user (if any).

Returns

array array of user domain names

logout()

logout

(

)

verifyUsername()

verifyUsername

(

$username

)

Validate the username passed to the auth plugin.

Parameters

string

$username

Returns

string username openid attribute user_id

Exceptions

OpenIDConnectClientException

Field Documentation

$client_id

$client_id

$client_secret

$client_secret

$provider_url

$provider_url

$redirect_uri

string $redirect_uri = null

$scopes

$scopes = ['openid', 'email', 'profile']

---

The documentation for this class was generated from the following file:

• lib/classes/auth_plugins/StudipAuthOIDC.php