Class AuthenticationResponse

Encapsulates authentication data.

Inheritance
System.Object
AuthenticationResponse
Implements
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Sartorius.SAF.Security
Assembly: Sartorius.SAF.dll
Syntax
[DataContract(IsReference = true)]
[Serializable]
[KnownType(typeof(RegionInfo))]
[KnownType(typeof(CultureInfo))]
[Obsolete("Use the new IAuthenticationProvider API")]
public class AuthenticationResponse : IExtendable

Constructors

View Source

AuthenticationResponse()

Initializes a new instance of the AuthenticationResponse class.

Declaration
public AuthenticationResponse()

Properties

View Source

AuthenticationError

The error that occured during authentication. When set, the single (boolean) properties are set according to this AuthenticationError.

Declaration
public AuthenticationError AuthenticationError { get; }
Property Value
Type Description
AuthenticationError
Remarks

The error is determined 'live' (when getting the value).

View Source

ChangingPwdRulesError

Indicates a error after logging or changing of password.

Declaration
[DataMember]
public string ChangingPwdRulesError { get; set; }
Property Value
Type Description
System.String
View Source

ErrorText

Gets or sets the error text. This is used to set any error text, despite the usual texts determined through the AuthenticationError

Declaration
[DataMember]
public string ErrorText { get; set; }
Property Value
Type Description
System.String

The error text.
View Source

IsCheckSumWrong

Gets or sets a value that indicates whether the checksum of the users data is wrong.

Declaration
[DataMember]
public bool IsCheckSumWrong { get; set; }
Property Value
Type Description
System.Boolean
View Source

IsLoginSuccessful

Indicates whether the login was successful.

Declaration
public bool IsLoginSuccessful { get; }
Property Value
Type Description
System.Boolean
View Source

IsPasswordExpired

Gets or sets a value that indicates whether the users password has expired.

Declaration
[DataMember]
public bool IsPasswordExpired { get; set; }
Property Value
Type Description
System.Boolean
View Source

IsPwdChangedSuccessful

Indicates whether changing of the users password was successful.

Declaration
public bool IsPwdChangedSuccessful { get; }
Property Value
Type Description
System.Boolean
View Source

IsUserAccountExpired

Gets or sets a value that indicates whether the user account is expired.

Declaration
[DataMember]
public bool IsUserAccountExpired { get; set; }
Property Value
Type Description
System.Boolean
View Source

IsUserAvailable

Gets or sets a value that indicates whether the user name exist in the SAF Db.

Declaration
[DataMember]
public bool IsUserAvailable { get; set; }
Property Value
Type Description
System.Boolean
View Source

IsUserLocked

Gets or sets a value that indicates whether the user account is locked.

Declaration
[DataMember]
public bool IsUserLocked { get; set; }
Property Value
Type Description
System.Boolean
View Source

IsUserPasswordCorrect

Gets or sets a value that indicating whether the users password is correct.

Declaration
[DataMember]
public bool IsUserPasswordCorrect { get; set; }
Property Value
Type Description
System.Boolean
View Source

PasswordExpireDate

Gets or sets the expire date of users password.

Declaration
[DataMember]
public DateTime PasswordExpireDate { get; set; }
Property Value
Type Description
System.DateTime
View Source

PrKey

Gets or sets the primary key of the authenticated user.

Declaration
[DataMember]
public Guid PrKey { get; set; }
Property Value
Type Description
System.Guid
View Source

Properties

Gets a dictionary of properties.

Declaration
[DataMember]
public Dictionary<string, object> Properties { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>
View Source

UserCulture

Gets or sets the users preferred culture.

Declaration
[DataMember]
public string UserCulture { get; set; }
Property Value
Type Description
System.String
View Source

UserId

Gets or sets the id of the authenticated user.

Declaration
[DataMember]
public string UserId { get; set; }
Property Value
Type Description
System.String
View Source

UserInfo

Gets or sets the info of the authenticated user.

Declaration
[DataMember]
public string UserInfo { get; set; }
Property Value
Type Description
System.String
View Source

UserName

Gets or sets the name of the authenticated user.

Declaration
[DataMember]
public string UserName { get; set; }
Property Value
Type Description
System.String

Methods

View Source

Reset()

Resets this instance's properties to its default values. This results in IsLoginSuccessful = true.

Declaration
public void Reset()

Implements

Extension Methods