Interface IAuthenticationService
Provides abstraction for authentication service in a vortex application.
Namespace: TcOpen.Inxton.Security
Assembly: TcOpen.Inxton.Abstractions.dll
Syntax
public interface IAuthenticationService
Properties
| Improve this Doc View SourceExternalAuthorization
Get or set external authentication device handling.
Declaration
IExternalAuthorization ExternalAuthorization { get; set; }
Property Value
Type | Description |
---|---|
IExternalAuthorization |
OnTimedLogoutRequest
Delegate is used to prevent/allow automatic user logout.
Declaration
OnTimedLogoutRequestDelegate OnTimedLogoutRequest { get; set; }
Property Value
Type | Description |
---|---|
OnTimedLogoutRequestDelegate |
Methods
| Improve this Doc View SourceAuthenticateUser(String, String)
Attempts to authenticate the user.
Declaration
IUser AuthenticateUser(string username, string password)
Parameters
Type | Name | Description |
---|---|---|
System.String | username | User name |
System.String | password | Password |
Returns
Type | Description |
---|---|
IUser |
CalculateHash(String, String)
Calculates hash of the password
Declaration
string CalculateHash(string clearTextPassword, string salt)
Parameters
Type | Name | Description |
---|---|---|
System.String | clearTextPassword | Plain test password |
System.String | salt | Salt |
Returns
Type | Description |
---|---|
System.String |
ChangePassword(String, String, String, String)
Changes the password of given user.
Declaration
void ChangePassword(string userName, string password, string newPassword1, string newPassword2)
Parameters
Type | Name | Description |
---|---|---|
System.String | userName | User name |
System.String | password | Old password |
System.String | newPassword1 | New password |
System.String | newPassword2 | New password |
DeAuthenticateCurrentUser()
De-authenticates current user.
Declaration
void DeAuthenticateCurrentUser()
HasAuthorization(String, Action)
Declaration
bool HasAuthorization(string roles, Action notAuthorizedAction = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | roles | |
System.Action | notAuthorizedAction |
Returns
Type | Description |
---|---|
System.Boolean |
Events
| Improve this Doc View SourceOnDeAuthenticated
Occurs when current user is de-authenticated.
Declaration
event OnUserAuthentication OnDeAuthenticated
Event Type
Type | Description |
---|---|
OnUserAuthentication |
OnDeAuthenticating
Occurs when current user is to be de-authenticated.
Declaration
event OnUserAuthentication OnDeAuthenticating
Event Type
Type | Description |
---|---|
OnUserAuthentication |
OnUserAuthenticateFailed
Occurs when user authentication fails.
Declaration
event OnUserAuthentication OnUserAuthenticateFailed
Event Type
Type | Description |
---|---|
OnUserAuthentication |
OnUserAuthenticateSuccess
Occurs when the uses is successfully authenticated.
Declaration
event OnUserAuthentication OnUserAuthenticateSuccess
Event Type
Type | Description |
---|---|
OnUserAuthentication |