2.3 Open and Close the Server

Thru server can be opened in 4 different ways by Open, OpenImmutable, OpenImmutableImpersonate or OpenWithTicket web service calls used by Thru SSO Ticket server or SSO-based applications.

Each call returns FTHSessionData data structure which contains Session ID and User ID of the user who logged in.

2.3.1 Data Structures

2.3.1.1 FTHSessionData
User Session data

2.3.2 Methods

2.3.2.1 Open

Open call opens the server using username and password and creates a session for given ApplicationID.
The session is alive until the next sign-in is done using Open or OpenWithTicket for the same user and the same ApplicationID, then new session replaces the previous.
Different applications are allowed to sign in concurrently under the same user.

FTHSessionData
Open(string userName, string password, int applicationID, string clientVersion)

2.3.2.2 OpenWithTicket

Accepts the ticket that contains user identity encrypted by Thru library on the client side. Encrypting party and Thru server should use the same password since encryption is symmetrical.
In order for OpenWithTicket call to succeed, Thru SSO product should be deployed on a customer’s LAN and a user whose identity is contained in the ticket had to be previously created by Thru SSO Sync server.
Thru SSO sync server synchronizes the contents of specified user group in corporate Active Directory with the user list in Thru server.

FTHSessionData
OpenWithTicket(string ticket, int applicationID)

2.3.2.3 OpenWithTicketEx

Accepts the ticket that contains user identity encrypted by a library on the client side.
Encrypting party and Thru server should use the same AES 256 bit symmetric encryption and same password Ticket is used for validation of the decrypting password and expiration purpose only,
the username string in the ticket is ignored. User is identified by EmailAddress string and session is created under the user with this email address.
If a user with the EmailAddress does not exit, user is created with FirstName, LastName and EmailAddress.

Ticket contains the following fields in encrypted form:

Encrypted ticket will contain the following information in the encrypted form – example:

<token timestamp="mm/dd/yyyy hh:mm:ss">
<sitename>yoursite.thruinc.net</sitename>
<username> DomainName\UserName</username>
</token>

FTHSessionData
OpenWithTicketEx (string ticket, string EmailAddress, string FirstName, string LastName, int applicationID, string ClientVersion)

2.3.2.4 OpenImmutable

Similar to Open call but the new session created in immutable mode, it will not be deleted when the next call is made which opens the server under  the same user and AplicationID. Used when session concurrency is required for one user account. Immutable sessions are cleaned automatically every 48 hours from the time they are created.

For SFTP and FTPS Application IDs the same immutable sessionID is returned which is already in use for given user. For other Application IDs multiple different immutable sessionIDs are crested on subsequent calls.

FTHSessionData
OpenImmutable(string userName, string password, int applicationID)

2.3.2.5 OpenImmutableImpersonate

Used when it is required to sign as a different user to perform and log the operation under the userID, which requires creation of a new user session token SessionID.
New session is created as immutable, session concurrency will be allowed.
Immutable sessions are cleaned automatically every 48 hours from the time they were created, or can be closed by explicit Close web service call.

FTHSessionData
OpenImmutableImpersonate(Guid serviceSessionId, int userID, int applicationID, string ipAddress)

2.3.2.6 OpenImmutableUserString

Similar to Open call but the new session created in immutable mode, it will not be deleted when the next call is made which opens the server under  the same user and AplicationID. Used when session concurrency is required for one user account. Immutable sessions are cleaned automatically every 48 hours from the time they are created.

For SFTP and FTPS Application IDs the same immutable sessionID is returned which is already in use for given user. For other Application IDs multiple different immutable sessionIDs are crested on subsequent calls.

If userString argument is passed, the value is recorded in Thru Audit on each file upload, download file delete operation.
If userString argument is passed, the value is recorded in Thru Audit on each file upload, download file delete operation.

FTHSessionData
OpenImmutableUserString(Guid serviceSessionId, int userID, int applicationID, string ipAddress, string userString)

2.3.2.7 Close

Close web call deletes existing user session.

Void
Close(Guid sessionID)