maintain the system, eg. user management etc More...

Static Public Member Functions
static bool	SetUserPassword (string AUsername, string ANewPassword, bool APasswordNeedsChanged, bool AUnretireIfRetired, string AClientComputerName, string AClientIPAddress, out TVerificationResultCollection AVerification)
	Sets the password of any existing user. This Method takes into consideration how users are authenticated in this system by using an optional authentication plugin DLL. Only users with Module Permission SYSMAN can call this Method! They don't need to supply the current Password of the user with this Method overload (they usually don't know this). The new password must meet the password quality criteria! More...

static bool	SetUserPassword (string AUserID, string ANewPassword, string ACurrentPassword, bool APasswordNeedsChanged, string AClientComputerName, string AClientIPAddress, out TVerificationResultCollection AVerification)
	Changes the password of the current user. This takes into consideration how users are authenticated in this system by using an optional authentication plugin DLL. Any user can call this, but they must only change their own password, they need to know their current password, the new password must meet the password quality criteria and it must not be the same than the current password! More...

static bool	LockSysadmin ()
	lock the user SYSADMIN while this instance is not assigned to a customer yet More...

static bool	CreateUser (string AUsername, string APassword, string AFirstName, string AFamilyName, string ALanguageCode, string AModulePermissions, string AToken, out string AUserID, TDataBase ADataBase=null)
	creates a user, either using the default authentication with the database or with the optional authentication plugin dll More...

static bool	GetAuthenticationFunctionality (out bool ACanCreateUser, out bool ACanChangePassword, out bool ACanChangePermissions)
	check the implementation of the authentication mechanism and which functionality is implemented for OpenPetra More...

static MaintainUsersTDS	LoadUsersAndModulePermissions ()
	load all users in the database and their permissions More...

static MaintainUsersTDS	CreateUserWithInitialPermissions ()
	create new user More...

static MaintainUsersTDS	LoadUserAndModulePermissions (string AUserId)
	load one user from the database and the permissions of that user More...

static bool	SaveUserAndModulePermissions (string AUserId, string AFirstName, string ALastName, string AEmailAddress, string ALanguageCode, bool AAccountLocked, bool ARetired, bool ASendMail, List< string > AModulePermissions, String AModificationId, out TVerificationResultCollection AVerificationResult)
	save the details and permissions of one user More...

static bool	SetInitialSysadminEmail (string AEmailAddress, string AFirstName, string ALastName, string ALanguageCode)
	set initial email address for user SYSADMIN More...

static bool	SendWelcomeEmail (string ASysAdminEmailAddress, string AUserEmailAddress, string AUserID, string AFirstName, string ALastName, string ALanguageCode)
	welcome the user and tell about the users and how to set the password More...

static bool	RequestNewPassword (string AEmailAddress)
	request new password More...

static bool	SetNewPassword (string AUserID, string AToken, string ANewPassword, out TVerificationResultCollection AVerificationResult)
	set a new password, authorized by the token that was sent via e-mail More...

static bool	SignUpSelfServiceEnabled (TDataBase ADataBase=null)
	has self service been enabled? More...

static bool	SignUpSelfService (string AEmailAddress, string AFirstName, string ALastName, string APassword, string ALanguageCode, out TVerificationResultCollection AVerification)
	sign up for self service More...

static bool	SignUpSelfServiceConfirm (string AUserID, string AToken)
	confirm the e-mail address for the self service account More...

static string	GetSelfServiceAssistant ()
	Is this user a self service user, and should be redirected to the MaintainPartnerSelfService window. More...

static TSubmitChangesResult	SaveSUser (ref MaintainUsersTDS ASubmitDS, string AClientComputerName, string AClientIPAddress)
	this is called from the MaintainUsers screen, for adding users, retiring users, set the password, etc More...

Static Public Attributes
static readonly string	DEMOMODULEPERMISSIONS = "DEMOMODULEPERMISSIONS"
	this will create some default module permissions, for demo purposes More...

Detailed Description

maintain the system, eg. user management etc

Member Function Documentation

◆ CreateUser()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.CreateUser	(	string	AUsername,
		string	APassword,
		string	AFirstName,
		string	AFamilyName,
		string	ALanguageCode,
		string	AModulePermissions,
		string	AToken,
		out string	AUserID,
		TDataBase	ADataBase = `null`
	)

inlinestatic

creates a user, either using the default authentication with the database or with the optional authentication plugin dll

◆ CreateUserWithInitialPermissions()

static MaintainUsersTDS Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.CreateUserWithInitialPermissions ( )

inlinestatic

create new user

◆ GetAuthenticationFunctionality()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.GetAuthenticationFunctionality	(	out bool	ACanCreateUser,
		out bool	ACanChangePassword,
		out bool	ACanChangePermissions
	)

inlinestatic

check the implementation of the authentication mechanism and which functionality is implemented for OpenPetra

Returns

◆ GetSelfServiceAssistant()

static string Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.GetSelfServiceAssistant ( )

inlinestatic

Is this user a self service user, and should be redirected to the MaintainPartnerSelfService window.

◆ LoadUserAndModulePermissions()

static MaintainUsersTDS Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.LoadUserAndModulePermissions ( string AUserId )

inlinestatic

load one user from the database and the permissions of that user

◆ LoadUsersAndModulePermissions()

static MaintainUsersTDS Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.LoadUsersAndModulePermissions ( )

inlinestatic

load all users in the database and their permissions

Returns

◆ LockSysadmin()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.LockSysadmin ( )

inlinestatic

lock the user SYSADMIN while this instance is not assigned to a customer yet

◆ RequestNewPassword()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.RequestNewPassword ( string AEmailAddress )

inlinestatic

request new password

◆ SaveSUser()

static TSubmitChangesResult Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.SaveSUser	(	ref MaintainUsersTDS	ASubmitDS,
		string	AClientComputerName,
		string	AClientIPAddress
	)

inlinestatic

this is called from the MaintainUsers screen, for adding users, retiring users, set the password, etc

◆ SaveUserAndModulePermissions()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.SaveUserAndModulePermissions	(	string	AUserId,
		string	AFirstName,
		string	ALastName,
		string	AEmailAddress,
		string	ALanguageCode,
		bool	AAccountLocked,
		bool	ARetired,
		bool	ASendMail,
		List< string >	AModulePermissions,
		String	AModificationId,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

save the details and permissions of one user

◆ SendWelcomeEmail()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.SendWelcomeEmail	(	string	ASysAdminEmailAddress,
		string	AUserEmailAddress,
		string	AUserID,
		string	AFirstName,
		string	ALastName,
		string	ALanguageCode
	)

inlinestatic

welcome the user and tell about the users and how to set the password

◆ SetInitialSysadminEmail()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.SetInitialSysadminEmail	(	string	AEmailAddress,
		string	AFirstName,
		string	ALastName,
		string	ALanguageCode
	)

inlinestatic

set initial email address for user SYSADMIN

◆ SetNewPassword()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.SetNewPassword	(	string	AUserID,
		string	AToken,
		string	ANewPassword,
		out TVerificationResultCollection	AVerificationResult
	)

inlinestatic

set a new password, authorized by the token that was sent via e-mail

◆ SetUserPassword() [1/2]

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.SetUserPassword	(	string	AUserID,
		string	ANewPassword,
		string	ACurrentPassword,
		bool	APasswordNeedsChanged,
		string	AClientComputerName,
		string	AClientIPAddress,
		out TVerificationResultCollection	AVerification
	)

inlinestatic

Changes the password of the current user. This takes into consideration how users are authenticated in this system by using an optional authentication plugin DLL. Any user can call this, but they must only change their own password, they need to know their current password, the new password must meet the password quality criteria and it must not be the same than the current password!

◆ SetUserPassword() [2/2]

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.SetUserPassword	(	string	AUsername,
		string	ANewPassword,
		bool	APasswordNeedsChanged,
		bool	AUnretireIfRetired,
		string	AClientComputerName,
		string	AClientIPAddress,
		out TVerificationResultCollection	AVerification
	)

inlinestatic

Sets the password of any existing user. This Method takes into consideration how users are authenticated in this system by using an optional authentication plugin DLL. Only users with Module Permission SYSMAN can call this Method! They don't need to supply the current Password of the user with this Method overload (they usually don't know this). The new password must meet the password quality criteria!

◆ SignUpSelfService()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.SignUpSelfService	(	string	AEmailAddress,
		string	AFirstName,
		string	ALastName,
		string	APassword,
		string	ALanguageCode,
		out TVerificationResultCollection	AVerification
	)

inlinestatic

sign up for self service

◆ SignUpSelfServiceConfirm()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.SignUpSelfServiceConfirm	(	string	AUserID,
		string	AToken
	)

inlinestatic

confirm the e-mail address for the self service account

◆ SignUpSelfServiceEnabled()

static bool Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.SignUpSelfServiceEnabled ( TDataBase ADataBase = null )

inlinestatic

has self service been enabled?

Member Data Documentation

◆ DEMOMODULEPERMISSIONS

readonly string Ict.Petra.Server.MSysMan.Maintenance.WebConnectors.TMaintenanceWebConnector.DEMOMODULEPERMISSIONS = "DEMOMODULEPERMISSIONS"

static

this will create some default module permissions, for demo purposes

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

csharp/ICT/Petra/Server/lib/MSysMan/UserManagement.cs

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ CreateUser()

◆ CreateUserWithInitialPermissions()

◆ GetAuthenticationFunctionality()

◆ GetSelfServiceAssistant()

◆ LoadUserAndModulePermissions()

◆ LoadUsersAndModulePermissions()

◆ LockSysadmin()

◆ RequestNewPassword()

◆ SaveSUser()

◆ SaveUserAndModulePermissions()

◆ SendWelcomeEmail()

◆ SetInitialSysadminEmail()

◆ SetNewPassword()

◆ SetUserPassword() [1/2]

◆ SetUserPassword() [2/2]

◆ SignUpSelfService()

◆ SignUpSelfServiceConfirm()

◆ SignUpSelfServiceEnabled()

Member Data Documentation

◆ DEMOMODULEPERMISSIONS