Authentication API - Revision history

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:02:53Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:02, 14 July 2021
				
Line 13:
Line 13:
===Mandatory:=== ===Mandatory:===



<code>auth_user_login ($username, $password)</syntaxhighlight> <syntaxhighlight lang="php">auth_user_login ($username, $password)</syntaxhighlight>



Authenticate username, password with userdatabase. Authenticate username, password with userdatabase.
Line 25:
Line 25:






<code>auth_get_userinfo($username)</syntaxhighlight> <syntaxhighlight lang="php">auth_get_userinfo($username)</syntaxhighlight>



Query other userinformation from database. Query other userinformation from database.



;Returns:User information in array ''(name => value, ...)'' or ''false'' in case of error. Function honors update-flags so if  <code>$CFG->auth_user_(atribute)_updatelocal</syntaxhighlight> is present, it will return value only if flag is true. ;Returns:User information in array ''(name => value, ...)'' or ''false'' in case of error. Function honors update-flags so if  <syntaxhighlight lang="php">$CFG->auth_user_(atribute)_updatelocal</syntaxhighlight> is present, it will return value only if flag is true.



===COURSE CREATING=== ===COURSE CREATING===






<code>auth_iscreator($username)</syntaxhighlight> <syntaxhighlight lang="php">auth_iscreator($username)</syntaxhighlight>



should user have rights to create courses should user have rights to create courses



;Returns:<code>true</syntaxhighlight> if user has rights to create cources otherwise false ;Returns:<syntaxhighlight lang="php">true</syntaxhighlight> if user has rights to create cources otherwise false



===USER CREATION=== ===USER CREATION===
Line 45:
Line 45:






<code>auth_user_exists ($username)</syntaxhighlight> <syntaxhighlight lang="php">auth_user_exists ($username)</syntaxhighlight>



Checks if given username exists on external db Checks if given username exists on external db



;Returns:<code>true</syntaxhighlight> if given usernname exist or false ;Returns:<syntaxhighlight lang="php">true</syntaxhighlight> if given usernname exist or false






<code>auth_user_create ($userobject,$plainpass)</syntaxhighlight> <syntaxhighlight lang="php">auth_user_create ($userobject,$plainpass)</syntaxhighlight>



Creates new user to external db. User should be created in inactive stage until confirmed by email. Creates new user to external db. User should be created in inactive stage until confirmed by email.



;Returns:<code>true</syntaxhighlight> on success otherwise <code>false</syntaxhighlight> ;Returns:<syntaxhighlight lang="php">true</syntaxhighlight> on success otherwise <syntaxhighlight lang="php">false</syntaxhighlight>






<code>auth_user_activate ($username)</syntaxhighlight> <syntaxhighlight lang="php">auth_user_activate ($username)</syntaxhighlight>



activate new user after email-address is confirmed activate new user after email-address is confirmed



;Returns:<code>true</syntaxhighlight> on success otherwise <code>false</syntaxhighlight> ;Returns:<syntaxhighlight lang="php">true</syntaxhighlight> on success otherwise <syntaxhighlight lang="php">false</syntaxhighlight>






<code>auth_user_disable ($username)</syntaxhighlight> <syntaxhighlight lang="php">auth_user_disable ($username)</syntaxhighlight>



deactivate user in external db. deactivate user in external db.



;Returns:<code>true</syntaxhighlight> on success otherwise <code>false</syntaxhighlight> ;Returns:<syntaxhighlight lang="php">true</syntaxhighlight> on success otherwise <syntaxhighlight lang="php">false</syntaxhighlight>



=== USER INFORMATION AND SYNCRONIZATION === === USER INFORMATION AND SYNCRONIZATION ===



<code>auth_get_userlist ()</syntaxhighlight> <syntaxhighlight lang="php">auth_get_userlist ()</syntaxhighlight>



Get list of usernames in external db. Get list of usernames in external db.



;Returns:All usernames in array or <code>false</syntaxhighlight> on error. ;Returns:All usernames in array or <syntaxhighlight lang="php">false</syntaxhighlight> on error.






<code>auth_get_users($filter='*')</syntaxhighlight> <syntaxhighlight lang="php">auth_get_users($filter='*')</syntaxhighlight>



Get ALL USEROBJECTS FROM EXTERNAL DB. Get ALL USEROBJECTS FROM EXTERNAL DB.

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:02:16Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 13:02, 14 July 2021
Line 13:		Line 13:
	===Mandatory:===		===Mandatory:===

	<code>auth_user_login ($username, $password)</~~code~~>		<code>auth_user_login ($username, $password)</syntaxhighlight>

	Authenticate username, password with userdatabase.		Authenticate username, password with userdatabase.
Line 25:		Line 25:


	<code>auth_get_userinfo($username)</~~code~~>		<code>auth_get_userinfo($username)</syntaxhighlight>

	Query other userinformation from database.		Query other userinformation from database.

	;Returns:User information in array ''(name => value, ...)'' or ''false'' in case of error. Function honors update-flags so if <code>$CFG->auth_user_(atribute)_updatelocal</~~code~~> is present, it will return value only if flag is true.		;Returns:User information in array ''(name => value, ...)'' or ''false'' in case of error. Function honors update-flags so if <code>$CFG->auth_user_(atribute)_updatelocal</syntaxhighlight> is present, it will return value only if flag is true.

	===COURSE CREATING===		===COURSE CREATING===


	<code>auth_iscreator($username)</~~code~~>		<code>auth_iscreator($username)</syntaxhighlight>

	should user have rights to create courses		should user have rights to create courses

	;Returns:<code>true</~~code~~> if user has rights to create cources otherwise false		;Returns:<code>true</syntaxhighlight> if user has rights to create cources otherwise false

	===USER CREATION===		===USER CREATION===
Line 45:		Line 45:


	<code>auth_user_exists ($username)</~~code~~>		<code>auth_user_exists ($username)</syntaxhighlight>

	Checks if given username exists on external db		Checks if given username exists on external db

	;Returns:<code>true</~~code~~> if given usernname exist or false		;Returns:<code>true</syntaxhighlight> if given usernname exist or false


	<code>auth_user_create ($userobject,$plainpass)</~~code~~>		<code>auth_user_create ($userobject,$plainpass)</syntaxhighlight>

	Creates new user to external db. User should be created in inactive stage until confirmed by email.		Creates new user to external db. User should be created in inactive stage until confirmed by email.

	;Returns:<code>true</~~code~~> on success otherwise <code>false</~~code~~>		;Returns:<code>true</syntaxhighlight> on success otherwise <code>false</syntaxhighlight>


	<code>auth_user_activate ($username)</~~code~~>		<code>auth_user_activate ($username)</syntaxhighlight>

	activate new user after email-address is confirmed		activate new user after email-address is confirmed

	;Returns:<code>true</~~code~~> on success otherwise <code>false</~~code~~>		;Returns:<code>true</syntaxhighlight> on success otherwise <code>false</syntaxhighlight>


	<code>auth_user_disable ($username)</~~code~~>		<code>auth_user_disable ($username)</syntaxhighlight>

	deactivate user in external db.		deactivate user in external db.

	;Returns:<code>true</~~code~~> on success otherwise <code>false</~~code~~>		;Returns:<code>true</syntaxhighlight> on success otherwise <code>false</syntaxhighlight>

	=== USER INFORMATION AND SYNCRONIZATION ===		=== USER INFORMATION AND SYNCRONIZATION ===

	<code>auth_get_userlist ()</~~code~~>		<code>auth_get_userlist ()</syntaxhighlight>

	Get list of usernames in external db.		Get list of usernames in external db.

	;Returns:All usernames in array or <code>false</~~code~~> on error.		;Returns:All usernames in array or <code>false</syntaxhighlight> on error.


	<code>auth_get_users($filter='*')</~~code~~>		<code>auth_get_users($filter='*')</syntaxhighlight>

	Get ALL USEROBJECTS FROM EXTERNAL DB.		Get ALL USEROBJECTS FROM EXTERNAL DB.

Deraadt: /* See also */

2011-06-10T07:42:29Z

Wmasterj at 07:18, 12 April 2011

2011-04-12T07:18:49Z

← Older revision		Revision as of 07:18, 12 April 2011
Line 13:		Line 13:
	===Mandatory:===		===Mandatory:===

	<code>~~'''~~auth_user_login ($username, $password)~~'''~~</code>		<code>auth_user_login ($username, $password)</code>

	Authenticate username, password with userdatabase.		Authenticate username, password with userdatabase.
Line 25:		Line 25:


	<code>~~'''~~auth_get_userinfo($username)~~'''~~</code>		<code>auth_get_userinfo($username)</code>

	Query other userinformation from database.		Query other userinformation from database.
Line 34:		Line 34:


	<code>~~'''~~auth_iscreator($username)~~'''~~</code>		<code>auth_iscreator($username)</code>

	should user have rights to create courses		should user have rights to create courses
Line 45:		Line 45:


	<code>~~'''~~auth_user_exists ($username)~~'''~~</code>		<code>auth_user_exists ($username)</code>

	Checks if given username exists on external db		Checks if given username exists on external db
Line 52:		Line 52:


	<code>~~'''~~auth_user_create ($userobject,$plainpass)~~'''~~</code>		<code>auth_user_create ($userobject,$plainpass)</code>

	Creates new user to external db. User should be created in inactive stage until confirmed by email.		Creates new user to external db. User should be created in inactive stage until confirmed by email.
Line 59:		Line 59:


	<code>~~'''~~auth_user_activate ($username)~~'''~~</code>		<code>auth_user_activate ($username)</code>

	activate new user after email-address is confirmed		activate new user after email-address is confirmed
Line 66:		Line 66:


	<code>~~'''~~auth_user_disable ($username)~~'''~~</code>		<code>auth_user_disable ($username)</code>

	deactivate user in external db.		deactivate user in external db.
Line 74:		Line 74:
	=== USER INFORMATION AND SYNCRONIZATION ===		=== USER INFORMATION AND SYNCRONIZATION ===

	<code>~~'''~~auth_get_userlist ()~~'''~~</code>		<code>auth_get_userlist ()</code>

	Get list of usernames in external db.		Get list of usernames in external db.
Line 81:		Line 81:


	<code>~~'''~~auth_get_users($filter='*')~~'''~~</code>		<code>auth_get_users($filter='*')</code>

	Get ALL USEROBJECTS FROM EXTERNAL DB.		Get ALL USEROBJECTS FROM EXTERNAL DB.

Wmasterj at 07:15, 12 April 2011

2011-04-12T07:15:45Z

Wmasterj at 07:06, 12 April 2011

2011-04-12T07:06:05Z

← Older revision		Revision as of 07:06, 12 April 2011
Line 1:		Line 1:

	The '''Authentication API''' describes Moodle's interface functions to authentication plugins.		The '''Authentication API''' describes Moodle's interface functions to authentication plugins.
	(This page is incomplete , I'll update it after I have phpdoc commented auth/ldap/lib.php)		(This page is incomplete , I'll update it after I have phpdoc commented auth/ldap/lib.php)

	Most of functions are from ldap-authentication module and are not implemented (yet?) on other modules. Please feel free to extend other modules to support same features or roll your own module.		Most of the functions are from the [[LDAP_authentication\|ldap-authentication module]] and are not implemented (yet?) on other modules. Please feel free to extend other modules to support same features or roll your own module.

	Some of new function are still tested and are not documented here yet.		Some of new function are still tested and are not documented here yet.
Line 23:		Line 22:
	===Optional:===		===Optional:===

	~~Following~~ functions are optional , but if present they extend module usability with Moodle.		The following functions are optional , but if present they extend module usability with Moodle.


Line 30:		Line 29:
	Query other userinformation from database.		Query other userinformation from database.

	Returns:		Returns: User information in array ''(name => value, ...)'' or ''false'' in case of error. Function honors update-flags so if <code>$CFG->auth_user_(atribute)_updatelocal</code> is present, it will return value only if flag is true.

	User information in array ''(name => value, ...)'' or ''false'' in case of error. Function honors update-flags so if
	<code>$CFG->auth_user_(atribute)_updatelocal</code>
	is present, it will return value only if flag is true.

	===COURSE CREATING===		===COURSE CREATING===

Wmasterj at 07:02, 12 April 2011

2011-04-12T07:02:38Z

← Older revision		Revision as of 07:02, 12 April 2011
Line 1:		Line 1:
	~~==Moodle authentication interface==~~

	The '''Authentication API''' describes Moodle interface functions to authentication ~~modules~~. (This page is incomplete , I'll update it after I have phpdoc commented auth/ldap/lib.php)		The '''Authentication API''' describes Moodle's interface functions to authentication plugins.
			(This page is incomplete , I'll update it after I have phpdoc commented auth/ldap/lib.php)

	Most of functions are from ldap-authentication module and are not implemented (yet?) on other modules. Please feel free to extend other modules to support same features or roll your own module.		Most of functions are from ldap-authentication module and are not implemented (yet?) on other modules. Please feel free to extend other modules to support same features or roll your own module.

Wmasterj: /* Moodle authentication interface */

2011-04-12T07:01:11Z

Moodle authentication interface

← Older revision		Revision as of 07:01, 12 April 2011
Line 1:		Line 1:
	==Moodle authentication interface==		==Moodle authentication interface==

	Authentication API ~~This file~~ describes Moodle interface functions to authentication modules. (This page is incomplete , I'll update it after I have phpdoc commented auth/ldap/lib.php)		The '''Authentication API''' describes Moodle interface functions to authentication modules. (This page is incomplete , I'll update it after I have phpdoc commented auth/ldap/lib.php)

	Most of functions are from ldap-authentication module and are not implemented (yet?) on other modules. Please feel free to extend other modules to support same features or roll your own module.		Most of functions are from ldap-authentication module and are not implemented (yet?) on other modules. Please feel free to extend other modules to support same features or roll your own module.

Wmasterj at 07:00, 12 April 2011

2011-04-12T07:00:20Z

← Older revision		Revision as of 07:00, 12 April 2011
Line 92:		Line 92:
	Returns: Array of all users as objects from external db		Returns: Array of all users as objects from external db


			== See also ==

			* [[Authentication plugins]]
			* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=102070 Overview of entire authentication code flow] forum discussion
			* Using Moodle [http://moodle.org/mod/forum/view.php?id=42 User authentication forum]
			* Moodle Docs [[Manage authentication]]
			* [[Authentication FAQ]]

	[[Category:Authentication API]]		[[Category:Authentication API]]

Wmasterj at 06:40, 12 April 2011

2011-04-12T06:40:35Z

← Older revision		Revision as of 06:40, 12 April 2011
Line 94:		Line 94:

	[[Category:Authentication API]]		[[Category:Authentication API]]
			[[Category:Authentication]]

	[[ru:Development:API Аутентификации]]		[[ru:Development:API Аутентификации]]

← Older revision		Revision as of 07:42, 10 June 2011
Line 96:		Line 96:
	* [[Authentication FAQ]]		* [[Authentication FAQ]]

	~~[[Category:Authentication API]]~~
	[[Category:Authentication]]		[[Category:Authentication]]

	~~[[ru:Development:API Аутентификации]]~~

← Older revision		Revision as of 07:15, 12 April 2011
Line 13:		Line 13:
	===Mandatory:===		===Mandatory:===

	'''auth_user_login ($username, $password)'''		<code>'''auth_user_login ($username, $password)'''</code>

	Authenticate username, password with userdatabase.		Authenticate username, password with userdatabase.

	Returns: true if the username and password work and false if they don't		;Returns:true if the username and password work and false if they don't


Line 25:		Line 25:


	'''auth_get_userinfo($username)'''		<code>'''auth_get_userinfo($username)'''</code>

	Query other userinformation from database.		Query other userinformation from database.

	Returns: User information in array ''(name => value, ...)'' or ''false'' in case of error. Function honors update-flags so if <code>$CFG->auth_user_(atribute)_updatelocal</code> is present, it will return value only if flag is true.		;Returns:User information in array ''(name => value, ...)'' or ''false'' in case of error. Function honors update-flags so if <code>$CFG->auth_user_(atribute)_updatelocal</code> is present, it will return value only if flag is true.

	===COURSE CREATING===		===COURSE CREATING===


	'''auth_iscreator($username)'''		<code>'''auth_iscreator($username)'''</code>

	should user have rights to create courses		should user have rights to create courses

	Returns: ~~True~~ if user has rights to create cources otherwise false		;Returns:<code>true</code> if user has rights to create cources otherwise false

	===USER CREATION===		===USER CREATION===
Line 45:		Line 45:


	'''auth_user_exists ($username)'''		<code>'''auth_user_exists ($username)'''</code>

	Checks if given username exists on external db		Checks if given username exists on external db

	Returns: true if given usernname exist or false		;Returns:<code>true</code> if given usernname exist or false


	'''auth_user_create ($userobject,$plainpass)'''		<code>'''auth_user_create ($userobject,$plainpass)'''</code>

	Creates new user to external db. User should be created in inactive stage until confirmed by email.		Creates new user to external db. User should be created in inactive stage until confirmed by email.

	Returns: ~~True~~ on success otherwise false		;Returns:<code>true</code> on success otherwise <code>false</code>


	'''auth_user_activate ($username)'''		<code>'''auth_user_activate ($username)'''</code>

	activate new user after email-address is confirmed		activate new user after email-address is confirmed

	Returns: ~~True~~ on success otherwise false		;Returns:<code>true</code> on success otherwise <code>false</code>


	'''auth_user_disable ($username)'''		<code>'''auth_user_disable ($username)'''</code>

	deactivate user in external db.		deactivate user in external db.

	Returns: ~~True~~ on success otherwise false		;Returns:<code>true</code> on success otherwise <code>false</code>

	=== USER INFORMATION AND SYNCRONIZATION ===		=== USER INFORMATION AND SYNCRONIZATION ===

	'''auth_get_userlist ()'''		<code>'''auth_get_userlist ()'''</code>

	Get list of usernames in external db.		Get list of usernames in external db.

	Returns: All usernames in array or false on error.		;Returns:All usernames in array or <code>false</code> on error.


	'''auth_get_users($filter='*')'''		<code>'''auth_get_users($filter='*')'''</code>

	Get ALL USEROBJECTS FROM EXTERNAL DB.		Get ALL USEROBJECTS FROM EXTERNAL DB.

	Returns: Array of all users as objects from external db		;Returns:Array of all users as objects from external db