OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Shared.Interfaces.Plugins.MSysMan.IUserAuthentication Interface Reference

This interface defines which methods need to be implemented by a plugin for authentication of users e.g. you can authenticate against an LDAP server or use the authentication of another application that the users are already using More...

Public Member Functions

bool AuthenticateUser (string AUsername, string APassword, out string AMessage)
 return true if the user is known and the password is correct; otherwise returns false and an error message More...
 
bool SetPassword (string AUsername, string APassword)
 this will allow the system administrator to change the password of the user More...
 
bool SetPassword (string AUsername, string APassword, string AOldPassword)
 this will allow the user to change his own password More...
 
bool CreateUser (string AUsername, string APassword, string AFamilyName, string AFirstName)
 this will create a new user More...
 
void GetAuthenticationFunctionality (out bool ACanCreateUser, out bool ACanChangePassword, out bool ACanChangePermissions)
 which functionality is implemented by this dll More...
 

Detailed Description

This interface defines which methods need to be implemented by a plugin for authentication of users e.g. you can authenticate against an LDAP server or use the authentication of another application that the users are already using

Member Function Documentation

◆ AuthenticateUser()

bool Ict.Petra.Shared.Interfaces.Plugins.MSysMan.IUserAuthentication.AuthenticateUser ( string  AUsername,
string  APassword,
out string  AMessage 
)

return true if the user is known and the password is correct; otherwise returns false and an error message

◆ CreateUser()

bool Ict.Petra.Shared.Interfaces.Plugins.MSysMan.IUserAuthentication.CreateUser ( string  AUsername,
string  APassword,
string  AFamilyName,
string  AFirstName 
)

this will create a new user

◆ GetAuthenticationFunctionality()

void Ict.Petra.Shared.Interfaces.Plugins.MSysMan.IUserAuthentication.GetAuthenticationFunctionality ( out bool  ACanCreateUser,
out bool  ACanChangePassword,
out bool  ACanChangePermissions 
)

which functionality is implemented by this dll

◆ SetPassword() [1/2]

bool Ict.Petra.Shared.Interfaces.Plugins.MSysMan.IUserAuthentication.SetPassword ( string  AUsername,
string  APassword 
)

this will allow the system administrator to change the password of the user

◆ SetPassword() [2/2]

bool Ict.Petra.Shared.Interfaces.Plugins.MSysMan.IUserAuthentication.SetPassword ( string  AUsername,
string  APassword,
string  AOldPassword 
)

this will allow the user to change his own password


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