Difference between revisions of "Authentication API"

Jump to: navigation, search
m (Authentication functions)
(Formatting. Page Hierarchy still a little unclear.)
Line 11: Line 11:
 
Basic functions to authenticate users with external db
 
Basic functions to authenticate users with external db
  
Mandatory:
 
  
auth_user_login ($username, $password)
+
===Mandatory:===
 +
 
 +
'''auth_user_login ($username, $password)'''
  
 
Authenticate username, password with userdatabase.
 
Authenticate username, password with userdatabase.
Line 19: Line 20:
 
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
  
Optional:
+
 
 +
===Optional:===
  
 
Following functions are optional , but if present they extends module usability with Moodle.
 
Following functions are optional , but if present they extends module usability with Moodle.
  
auth_get_userinfo($username)
+
 
 +
'''auth_get_userinfo($username)'''
  
 
Query other userinformation from database.
 
Query other userinformation from database.
Line 33: Line 36:
 
is present, it will return value anly if flag is true.
 
is present, it will return value anly if flag is true.
  
COURSE CREATING
 
  
auth_iscreator($username)
+
===COURSE CREATING===
 +
 
 +
 
 +
'''auth_iscreator($username)'''
  
 
should user have rights to create courses
 
should user have rights to create courses
Line 41: Line 46:
 
Returns: True if user has rights to create cources otherwise false
 
Returns: True if user has rights to create cources otherwise false
  
USER CREATION
+
===USER CREATION===
  
 
Functions that enable user creation, activation and deactivation from moodle to external database
 
Functions that enable user creation, activation and deactivation from moodle to external database
  
auth_user_exists ($username)
+
 
 +
'''auth_user_exists ($username)'''
  
 
Checks if given username exists on external db
 
Checks if given username exists on external db
Line 51: Line 57:
 
Returns: true if given usernname exist or false
 
Returns: true if given usernname exist or false
  
auth_user_create ($userobject,$plainpass)
+
 
 +
'''auth_user_create ($userobject,$plainpass)'''
  
 
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 57: Line 64:
 
Returns: True on success otherwise false
 
Returns: True on success otherwise false
  
auth_user_activate ($username)
+
 
 +
'''auth_user_activate ($username)'''
  
 
activate new user after email-address is confirmed
 
activate new user after email-address is confirmed
Line 63: Line 71:
 
Returns: True on success otherwise false
 
Returns: True on success otherwise false
  
auth_user_disable ($username) {
+
 
 +
'''auth_user_disable ($username) {'''
  
 
deactivate user in external db.
 
deactivate user in external db.
Line 71: Line 80:
 
USER INFORMATION AND SYNCRONIZATION
 
USER INFORMATION AND SYNCRONIZATION
  
auth_get_userlist ()
+
 
 +
'''auth_get_userlist ()'''
  
 
Get list of usernames in external db.
 
Get list of usernames in external db.
Line 77: Line 87:
 
Returns: All usernames in array or false on error.
 
Returns: All usernames in array or false on error.
  
auth_get_users($filter='*')
+
 
 +
'''auth_get_users($filter='*')'''
  
 
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

Revision as of 13:37, 16 November 2006

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)

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.

Some of new function are still tested and are not documented here yet.

Authentication functions

Basic functions to authenticate users with external db


Mandatory:

auth_user_login ($username, $password)

Authenticate username, password with userdatabase.

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


Optional:

Following functions are optional , but if present they extends module usability with Moodle.


auth_get_userinfo($username)

Query other userinformation from database.

Returns:

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


COURSE CREATING

auth_iscreator($username)

should user have rights to create courses

Returns: True if user has rights to create cources otherwise false

USER CREATION

Functions that enable user creation, activation and deactivation from moodle to external database


auth_user_exists ($username)

Checks if given username exists on external db

Returns: true if given usernname exist or false


auth_user_create ($userobject,$plainpass)

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

Returns: True on success otherwise false


auth_user_activate ($username)

activate new user after email-address is confirmed

Returns: True on success otherwise false


auth_user_disable ($username) {

deactivate user in external db.

Returns: True on success otherwise false

USER INFORMATION AND SYNCRONIZATION


auth_get_userlist ()

Get list of usernames in external db.

Returns: All usernames in array or false on error.


auth_get_users($filter='*')

Get ALL USEROBJECTS FROM EXTERNAL DB.

Returns: Array of all users as objects from external db