Provides methods to log users on and off and manage their settings. More...
Public Member Functions | |
void | ChangeForgottenPassword (string sessionId, string newPassword) |
Changes the password for a resource after validating the resource with the new password provided and user is logged off. More... | |
LogonState | ChangePassword (string sessionId, string oldPassword, string newPassword) |
Changes the password once the old password is confirmed. The newPassword must match with Password Format defined in Server Settings. More... | |
string | FederatedLogOff (string sessionId) |
Logs the user out of TotalAgility. If Authentication Provider ‘Logout’ option is set to TotalAgility and Provider , returns a URL which can be used to log out of the Provider; otherwise returns an empty string. More... | |
void | ForgotPassword (string emailAddress) |
Sends an email to change the password to the email address you have provided. User need to complete all the required steps mentioned in the email to change the password. More... | |
AuthenticationProvidersForSignIn | GetFederatedAuthenticationProvidersForSignIn (string callbackUrl, short callbackProtocol, string origin) |
Gets a list of Authentication Providers for Sign In More... | |
string | GetFederatedAuthenticationSignInUrl (string callbackUrl, AuthenticationProviderIdentity authenticationProviderIdentity, short callbackProtocol, string origin) |
Creates the sign-in url to the specified authentication provider More... | |
LoggedOnUserCollection | GetLoggedOnUsers (string sessionId) |
Retrieves the logged on users for the current session. More... | |
LoggedOnUser2Collection | GetLoggedOnUsers2 (string sessionId) |
Retrieves the logged on users for the current session. More... | |
Session | GetSession (UserIdentity2 userIdentity) |
Retrieves session details for the specified user. More... | |
Session | GetSessionWithPassword (UserIdentityWithPassword userIdentity) |
Retrieves session details for the specified user. More... | |
Session | GetSingleSignOnSession (string systemSessionId, UserIdentity2 userIdentity) |
Gets the session for specified user for the System Session Id. More... | |
string | GetWindowsUser () |
Retrieves the Windows user name of the currently logged in user. More... | |
void | LogOff (string sessionId) |
Logs off the user associated with the specified session Id. More... | |
void | LogOffUsers (string sessionId, StringCollection sessionIds) |
Logs off users associated with each of the specified session Ids. More... | |
void | LogOffUsers2 (string sessionId, StringCollection resourceIds) |
Logs off users associated with each of the specified resource Ids. More... | |
Session | LogOn (UserIdentity userIdentity) |
This function is deprecated. Please use LogOn2 instead. Logs the specified user on to the system. The user will be validated and their security rights will ve verified. More... | |
Session2 | LogOn2 (UserIdentity userIdentity) |
Logs the specified user on to the system. The user will be validated and their security rights will ve verified. More... | |
Session | LogOnWithEmailAddress (UserEmailIdentity userEmailIdentity) |
This function is deprecated. Please use LogOnWithEmailAddress2 instead. Logs in the user that has the specified email address. More... | |
Session2 | LogOnWithEmailAddress2 (UserEmailIdentity userEmailIdentity) |
Logs in the user that has the specified email address. More... | |
Session | LogOnWithPassword (UserIdentityWithPassword userIdentityWithPassword) |
This function is deprecated. Please use LogOnWithPassword2 instead. Logs the specified user on to the system. The user will be validated and their security rights will ve verified. More... | |
Session2 | LogOnWithPassword2 (UserIdentityWithPassword userIdentityWithPassword) |
Logs the specified user on to the system. The user will be validated and their security rights will ve verified. More... | |
Session | LogOnWithWindowsAuthentication (short logOnProtocol, bool unconditionalLogOn) |
This function is deprecated. Please use LogOnWithWindowsAuthentication2 instead. Logs in the current Windows user using Windows authentication. More... | |
Session2 | LogOnWithWindowsAuthentication2 (short logOnProtocol, bool unconditionalLogOn) |
Logs in the current Windows user using Windows authentication. More... | |
LogonState | SupplyPasscode (string sessionId, string passcode) |
Accepts the passcode from the user, validates it, updates passcode's verifiedtime if the validation succeeds(i.e LogonState.LogonStateType == Loggedon) the service will add a cookie to the response with the details populated in the logonstate returned More... | |
Session | ValidateSession (string sessionId) |
Validates that the specified session is valid. More... | |
Provides methods to log users on and off and manage their settings.
void ChangeForgottenPassword | ( | string | sessionId, |
string | newPassword | ||
) |
Changes the password for a resource after validating the resource with the new password provided and user is logged off.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
newPassword | The new password. |
LogonState ChangePassword | ( | string | sessionId, |
string | oldPassword, | ||
string | newPassword | ||
) |
Changes the password once the old password is confirmed. The newPassword must match with Password Format defined in Server Settings.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
oldPassword | The old password. |
newPassword | The new password. |
string FederatedLogOff | ( | string | sessionId | ) |
Logs the user out of TotalAgility. If Authentication Provider ‘Logout’ option is set to TotalAgility and Provider
, returns a URL which can be used to log out of the Provider; otherwise returns an empty string.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
void ForgotPassword | ( | string | emailAddress | ) |
Sends an email to change the password to the email address you have provided. User need to complete all the required steps mentioned in the email to change the password.
emailAddress | The email address. |
AuthenticationProvidersForSignIn GetFederatedAuthenticationProvidersForSignIn | ( | string | callbackUrl, |
short | callbackProtocol, | ||
string | origin | ||
) |
Gets a list of Authentication Providers for Sign In
callbackUrl | The calback URL. |
callbackProtocol | The Authentication Provider callback protocol. See Remarks below for relevant values |
origin | The origin URL |
Enumeration | Description |
---|---|
0 | Designer |
1 | Workspace |
string GetFederatedAuthenticationSignInUrl | ( | string | callbackUrl, |
AuthenticationProviderIdentity | authenticationProviderIdentity, | ||
short | callbackProtocol, | ||
string | origin | ||
) |
Creates the sign-in url to the specified authentication provider
callbackUrl | The calback URL. |
authenticationProviderIdentity | The Authentication Provider Identity. |
callbackProtocol | The Authentication Provider callback protocol. See Remarks below for relevant values |
origin | The origin URL |
Enumeration | Description |
---|---|
0 | Designer |
1 | Workspace |
LoggedOnUserCollection GetLoggedOnUsers | ( | string | sessionId | ) |
Retrieves the logged on users for the current session.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
Name | Type | Comment |
---|---|---|
Resource | Identity | Id, Name and ResourceType of the logged in user |
UserId | String | Nt name of the user |
SessionId | String | The user's session ID |
Logon Protocol | Int16 | Logon protocol for the user |
LastActiveTime | DateTime? | The date and time the user last performed an action while logged on |
LastAccessTime | DateTime? | The date and time the user last accessed. |
LoggedOnUser2Collection GetLoggedOnUsers2 | ( | string | sessionId | ) |
Retrieves the logged on users for the current session.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
Name | Type | Comment |
---|---|---|
Resource | Identity | Id, Name and ResourceType of the logged in user |
UserId | String | User name of the user |
logonprotocols | String | This contains list of comma seperated Logon protocols for the user |
LastAccessTime | DateTime | The date and time the user last accessed. |
Session GetSession | ( | UserIdentity2 | userIdentity | ) |
Retrieves session details for the specified user.
userIdentity | A Model.Users.UserIdentity2 object that is used to identify the user to get the session.
|
Name | Type | Comment |
---|---|---|
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
Session GetSessionWithPassword | ( | UserIdentityWithPassword | userIdentity | ) |
Retrieves session details for the specified user.
userIdentity | A UserIdentityWithPassword object that is used to identify the user to get the session.
|
Name | Type | Comment |
---|---|---|
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
Session GetSingleSignOnSession | ( | string | systemSessionId, |
UserIdentity2 | userIdentity | ||
) |
Gets the session for specified user for the System Session Id.
systemSessionId | The system session identifier. An exception is generated if session is not provided. | ||||||||||||
userIdentity | A UserIdentity2 object that identifies a KTA user.
|
Name | Type | Comment |
---|---|---|
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
Enumeration | Description |
---|---|
5 | Ide |
7 | Internet |
8 | Transformation Ide |
string GetWindowsUser | ( | ) |
Retrieves the Windows user name of the currently logged in user.
void LogOff | ( | string | sessionId | ) |
Logs off the user associated with the specified session Id.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
void LogOffUsers | ( | string | sessionId, |
StringCollection | sessionIds | ||
) |
Logs off users associated with each of the specified session Ids.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
sessionIds | A StringCollection object that contains list of session Ids to logoff.
|
void LogOffUsers2 | ( | string | sessionId, |
StringCollection | resourceIds | ||
) |
Logs off users associated with each of the specified resource Ids.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
resourceIds | A StringCollection object that contains list of resource Ids to logoff.
|
Session LogOn | ( | UserIdentity | userIdentity | ) |
This function is deprecated. Please use LogOn2 instead.
Logs the specified user on to the system. The user will be validated and their security rights will ve verified.
userIdentity | A UserIdentity object that is used to identify the user to logon.
|
Name | Type | Comment |
---|---|---|
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
true
then UnconditionalLogOn has no effect. If the user is already logged in then the existing session will be returned otherwise a new one will be created.false
and UnconditionalLogOn is also false
then an exception will be raised if the user is already logged on. If they were not logged on then a new session will created. false
and UnconditionalLogOn is true
then:Session2 LogOn2 | ( | UserIdentity | userIdentity | ) |
Logs the specified user on to the system. The user will be validated and their security rights will ve verified.
userIdentity | A UserIdentity object that is used to identify the user to logon.
|
Name | Type | Comment |
---|---|---|
ReserveLicenseUsed | Boolean | Indicates whether the user uses a reserve license |
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
true
then UnconditionalLogOn has no effect. If the user is already logged in then the existing session will be returned otherwise a new one will be created.false
and UnconditionalLogOn is also false
then an exception will be raised if the user is already logged on. If they were not logged on then a new session will created. false
and UnconditionalLogOn is true
then:Session LogOnWithEmailAddress | ( | UserEmailIdentity | userEmailIdentity | ) |
This function is deprecated. Please use LogOnWithEmailAddress2 instead.
Logs in the user that has the specified email address.
userEmailIdentity | A UserEmailIdentity object containing the email address and the logon protocol to logon to the system.
|
Name | Type | Comment |
---|---|---|
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
Session2 LogOnWithEmailAddress2 | ( | UserEmailIdentity | userEmailIdentity | ) |
Logs in the user that has the specified email address.
userEmailIdentity | A UserEmailIdentity object containing the email address and the logon protocol to logon to the system.
|
Name | Type | Comment |
---|---|---|
ReserveLicenseUsed | Boolean | Indicates whether the user uses a reserve license |
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
Session LogOnWithPassword | ( | UserIdentityWithPassword | userIdentityWithPassword | ) |
This function is deprecated. Please use LogOnWithPassword2 instead.
Logs the specified user on to the system. The user will be validated and their security rights will ve verified.
userIdentityWithPassword | A UserIdentityWithPassword object that is used to identify the user to logon with password.
|
Name | Type | Comment |
---|---|---|
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
true
then UnconditionalLogOn has no effect. If the user is already logged in then the existing session will be returned otherwise a new one will be created.false
and UnconditionalLogOn is also false
then an exception will be raised if the user is already logged on. If they were not logged on then a new session will created. false
and UnconditionalLogOn is true
then:Session2 LogOnWithPassword2 | ( | UserIdentityWithPassword | userIdentityWithPassword | ) |
Logs the specified user on to the system. The user will be validated and their security rights will ve verified.
userIdentityWithPassword | A UserIdentityWithPassword object that is used to identify the user to logon with password.
|
Name | Type | Comment |
---|---|---|
ReserveLicenseUsed | Boolean | Indicates whether the user uses a reserve license |
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
true
then UnconditionalLogOn has no effect. If the user is already logged in then the existing session will be returned otherwise a new one will be created.false
and UnconditionalLogOn is also false
then an exception will be raised if the user is already logged on. If they were not logged on then a new session will created. false
and UnconditionalLogOn is true
then:Session LogOnWithWindowsAuthentication | ( | short | logOnProtocol, |
bool | unconditionalLogOn | ||
) |
This function is deprecated. Please use LogOnWithWindowsAuthentication2 instead.
Logs in the current Windows user using Windows authentication.
logOnProtocol | Specifies the type of Logon Protocol to use. |
unconditionalLogOn | Indicates that a new session should be created if the user is already logged on |
Name | Type | Comment |
---|---|---|
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
true
then UnconditionalLogOn has no effect. If the user is already logged in then the existing session will be returned otherwise a new one will be created.false
and UnconditionalLogOn is also false
then an exception will be raised if the user is already logged on. If they were not logged on then a new session will created. false
and UnconditionalLogOn is true
then:Session2 LogOnWithWindowsAuthentication2 | ( | short | logOnProtocol, |
bool | unconditionalLogOn | ||
) |
Logs in the current Windows user using Windows authentication.
logOnProtocol | Specifies the type of Logon Protocol to use. |
unconditionalLogOn | Indicates that a new session should be created if the user is already logged on |
Name | Type | Comment |
---|---|---|
ReserveLicenseUsed | Boolean | Indicates whether the user uses a reserve license |
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |
true
then UnconditionalLogOn has no effect. If the user is already logged in then the existing session will be returned otherwise a new one will be created.false
and UnconditionalLogOn is also false
then an exception will be raised if the user is already logged on. If they were not logged on then a new session will created. false
and UnconditionalLogOn is true
then:LogonState SupplyPasscode | ( | string | sessionId, |
string | passcode | ||
) |
Accepts the passcode from the user, validates it, updates passcode's verifiedtime if the validation succeeds(i.e LogonState.LogonStateType == Loggedon) the service will add a cookie to the response with the details populated in the logonstate returned
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
passcode | The passcode. |
Session ValidateSession | ( | string | sessionId | ) |
Validates that the specified session is valid.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
Name | Type | Comment |
---|---|---|
SessionId | String | The user's session ID |
ResourceId | String | The user's user ID |
DisplayName | String | The user's name |
isValid | Boolean | Will be true if the session is valid |
LogonState | LogonState | The logon state information |