Simias::Authentication::Status Class Reference

Defines the Status class which is returned on all remote authentication methods. More...

List of all members.

Public Member Functions
	Status ()
	Set Status to Unknown.
	Status (StatusCodes status)
	Set method for Status.
Public Attributes
StatusCodes	statusCode
	Status of the authentication. Must always be a valid status code.
string	DomainID
	Unique ID of the domain. Valid on a successful authentication.
string	UserID
	Unique ID of the user Valid on a successful authentication.
string	UserName
	UserName.
string	DistinguishedUserName
	Distinguished or unique user name used for the authentication. This member can be the same as the UserName.
string	ExceptionMessage
	ExceptionMessage returned when an internal exception occurred while trying to authenticate the user.
int	TotalGraceLogins
	TotalGraceLogins the number of allowed on this account by policy.
int	RemainingGraceLogins
	RemainingGraceLogins the number of grace logins left on this account.
int	DaysUntilPasswordExpires = -1
	The number of days until the users password expires.

---

Detailed Description

Defines the Status class which is returned on all remote authentication methods.

---

Constructor & Destructor Documentation

Simias::Authentication::Status::Status

(

)

[inline]

Set Status to Unknown.

Simias::Authentication::Status::Status

(

StatusCodes

status

)

[inline]

Set method for Status.

Parameters:

status

status to set

---

Member Data Documentation

StatusCodes Simias::Authentication::Status::statusCode

Status of the authentication. Must always be a valid status code.

string Simias::Authentication::Status::DomainID

Unique ID of the domain. Valid on a successful authentication.

string Simias::Authentication::Status::UserID

Unique ID of the user Valid on a successful authentication.

string Simias::Authentication::Status::UserName

UserName.

Valid if the authentication was successful

string Simias::Authentication::Status::DistinguishedUserName

Distinguished or unique user name used for the authentication. This member can be the same as the UserName.

Valid if the authentication was successful

string Simias::Authentication::Status::ExceptionMessage

ExceptionMessage returned when an internal exception occurred while trying to authenticate the user.

Valid if status == StatusCode.InternalException

int Simias::Authentication::Status::TotalGraceLogins

TotalGraceLogins the number of allowed on this account by policy.

Valid if status == StatusCode.SuccessInGrace

int Simias::Authentication::Status::RemainingGraceLogins

RemainingGraceLogins the number of grace logins left on this account.

Valid if status == StatusCode.SuccessInGrace

int Simias::Authentication::Status::DaysUntilPasswordExpires = -1

The number of days until the users password expires.

Valid if status == StatusCode.Success

---

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

• src/core/Credentials/Credentials.cs