Simias::Server::User Class Reference

Class to manage users in the enterprise server domain. More...

Collaboration diagram for Simias::Server::User:

List of all members.

Public Member Functions

User (string Username)

Constructor for managing users in the enterprise domain.

RegistrationInfo Create (string Password)

Method to create a user/identity in the external user database. Some external systems may not allow for creation of new users.

UserProviderCaps GetCapabilities ()

Method to retrieve the capabilities of a user identity provider.

bool Delete ()

Method to delete a member from the domain.

Static Public Member Functions

static IUserProvider GetRegisteredProvider ()

Method to get an instance of the registered identity provider. There can only be one identity provider in the system.

static bool RegisterProvider (IUserProvider provider)

Method to register an identity provider with the system.

static bool UnregisterProvider (IUserProvider provider)

Method to deregister an identity provider with the system.

static bool SetPassword (string Username, string Password)

Method to set/reset a user's password Note: This method will be replaced when the self-service framework is designed and implemented.

static bool VerifyPassword (string Username, string Password, Simias.Authentication.Status status)

Method to verify a user's password.

Properties

string UserName [get, set]

Username.

string UserGuid [get, set]

Guid.

string FirstName [get, set]

First Name.

string LastName [get, set]

Last Name.

string FullName [get, set]

Full Name.

string DN [get, set]

Distinguished Name.

string Email [get, set]

Primary e-mail address.

Detailed Description

Class to manage users in the enterprise server domain.

Constructor & Destructor Documentation

Simias::Server::User::User ( string Username ) [inline]

Constructor for managing users in the enterprise domain.

Member Function Documentation

static IUserProvider Simias::Server::User::GetRegisteredProvider ( ) [inline, static]

Method to get an instance of the registered identity provider. There can only be one identity provider in the system.

Returns:: an IUserProvider instance

static bool Simias::Server::User::RegisterProvider ( IUserProvider provider ) [inline, static]

Method to register an identity provider with the system.

Returns:: true success - false failure

static bool Simias::Server::User::UnregisterProvider ( IUserProvider provider ) [inline, static]

Method to deregister an identity provider with the system.

Returns:: true success - false failure

RegistrationInfo Simias::Server::User::Create ( string Password ) [inline]

Method to create a user/identity in the external user database. Some external systems may not allow for creation of new users.

Parameters:

Password

Password associated to the user.

Returns:: RegistrationStatus

UserProviderCaps Simias::Server::User::GetCapabilities ( ) [inline]

Method to retrieve the capabilities of a user identity provider.

Returns:: providers capabilities

bool Simias::Server::User::Delete ( ) [inline]

Method to delete a member from the domain.

Returns:: True if the user is successfully deleted; otherwise, False is returned.

static bool Simias::Server::User::SetPassword	(	string	Username,
		string	Password
	)			`[inline, static]`

Method to set/reset a user's password Note: This method will be replaced when the self-service framework is designed and implemented.

Parameters:

	Username	Username to set the password on.
	Password	New password.

Returns:: true - successful

static bool Simias::Server::User::VerifyPassword	(	string	Username,
		string	Password,
		Simias.Authentication.Status	status
	)			`[inline, static]`

Method to verify a user's password.

Parameters:

	Username	User to verify the password against
	Password	Password to verify
	status	Structure used to pass additional information back to the user.

Returns:: true - Valid password, false Invalid password

Property Documentation

string Simias::Server::User::UserName [get, set]

Username.

string Simias::Server::User::UserGuid [get, set]

Guid.

string Simias::Server::User::FirstName [get, set]

First Name.

string Simias::Server::User::LastName [get, set]

Last Name.

string Simias::Server::User::FullName [get, set]

Full Name.

string Simias::Server::User::DN [get, set]

Distinguished Name.

string Simias::Server::User::Email [get, set]

Primary e-mail address.

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

src/server/Simias.Server/User.cs


Public Member Functions
	User (string Username)
	Constructor for managing users in the enterprise domain.
RegistrationInfo	Create (string Password)
	Method to create a user/identity in the external user database. Some external systems may not allow for creation of new users.
UserProviderCaps	GetCapabilities ()
	Method to retrieve the capabilities of a user identity provider.
bool	Delete ()
	Method to delete a member from the domain.
Static Public Member Functions
static IUserProvider	GetRegisteredProvider ()
	Method to get an instance of the registered identity provider. There can only be one identity provider in the system.
static bool	RegisterProvider (IUserProvider provider)
	Method to register an identity provider with the system.
static bool	UnregisterProvider (IUserProvider provider)
	Method to deregister an identity provider with the system.
static bool	SetPassword (string Username, string Password)
	Method to set/reset a user's password Note: This method will be replaced when the self-service framework is designed and implemented.
static bool	VerifyPassword (string Username, string Password, Simias.Authentication.Status status)
	Method to verify a user's password.
Properties
string	UserName `[get, set]`
	Username.
string	UserGuid `[get, set]`
	Guid.
string	FirstName `[get, set]`
	First Name.
string	LastName `[get, set]`
	Last Name.
string	FullName `[get, set]`
	Full Name.
string	DN `[get, set]`
	Distinguished Name.
string	Email `[get, set]`
	Primary e-mail address.