Simias::Server::IUserProvider Interface Reference

Interface for an external identity/user provider. More...

Inheritance diagram for Simias::Server::IUserProvider:

[legend]

List of all members.

Public Member Functions
RegistrationInfo	Create (string Guid, string Username, string Password, string Firstname, string Lastname, string Fullname, string Distinguished)
	Method to create a user/identity in the external user database. Some external systems may not allow for creation of new users.
bool	Delete (string Username)
	Method to delete a user from the external identity/user database. Some external systems may not allow deletion of users.
UserProviderCaps	GetCapabilities ()
	Method to retrieve the capabilities of a user identity provider.
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.
bool	VerifyPassword (string Username, string Password, Simias.Authentication.Status status)
	Method to verify a user's password.
Properties
string	Name [get]
	Gets the name of the provider.
string	Description [get]
	Gets the description of the provider.

---

Detailed Description

Interface for an external identity/user provider.

---

Member Function Documentation

RegistrationInfo Simias::Server::IUserProvider::Create	(	string	Guid,
		string	Username,
		string	Password,
		string	Firstname,
		string	Lastname,
		string	Fullname,
		string	Distinguished
	)

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

Parameters:

	Guid	Guid associated to the user.
	Username	User or short name for the new user.
	Password	Password associated to the user.
	Firstname	First or given name associated to the user.
	Lastname	Last or family name associated to the user.
	Fullname	Full or complete name associated to the user.
	Distinguished	Distinguished name of the user.

Returns:

RegistrationStatus

Implemented in Simias::ADLdapProvider::User, Simias::LdapProvider::User, Simias::OpenLdapProvider::User, and Simias::Server::InternalUser.

bool Simias::Server::IUserProvider::Delete

(

string

Username

)

Method to delete a user from the external identity/user database. Some external systems may not allow deletion of users.

Parameters:

Username

Name of the user to delete from the external system.

Returns:

true - successful false - failed

Implemented in Simias::ADLdapProvider::User, Simias::LdapProvider::User, Simias::OpenLdapProvider::User, and Simias::Server::InternalUser.

UserProviderCaps Simias::Server::IUserProvider::GetCapabilities

(

)

Method to retrieve the capabilities of a user identity provider.

Returns:

providers capabilities

Implemented in Simias::ADLdapProvider::User, Simias::LdapProvider::User, Simias::OpenLdapProvider::User, and Simias::Server::InternalUser.

bool Simias::Server::IUserProvider::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.

Parameters:

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

Returns:

true - successful

Implemented in Simias::ADLdapProvider::User, Simias::LdapProvider::User, Simias::OpenLdapProvider::User, and Simias::Server::InternalUser.

bool Simias::Server::IUserProvider::VerifyPassword	(	string	Username,
		string	Password,
		Simias.Authentication.Status	status
	)

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

Implemented in Simias::ADLdapProvider::User, Simias::OpenLdapProvider::User, and Simias::Server::InternalUser.

---

Property Documentation

string Simias::Server::IUserProvider::Name [get]

Gets the name of the provider.

Implemented in Simias::ADLdapProvider::User, Simias::LdapProvider::User, Simias::OpenLdapProvider::User, and Simias::Server::InternalUser.

string Simias::Server::IUserProvider::Description [get]

Gets the description of the provider.

Implemented in Simias::ADLdapProvider::User, Simias::LdapProvider::User, Simias::OpenLdapProvider::User, and Simias::Server::InternalUser.

---

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

• src/server/Simias.Server/IUserProvider.cs