6.1 Authentication Service
6.1.1 POST New Session Object
Url | [ThruWebServer]/REST/[version]/Session |
|---|---|
Verb | POST |
Required HTTP Headers | Accept: (application/xml or application/json) Content-Type: application/x-www-form-urlencoded |
Description | Verify user credentials and authenticate Thru user in the system. Optionally passes external user information for audit purposes in UserString for the session opened. Device_UUID parameter is mandatory and can be set to any string. |
Request Body | ThruSessionRequest object |
Return Data Object | ThruPublicSession object |
Invocation Scenario(s) | Verify customer credentials |
Remarks | UserName=Test&Password=Password&ClientVersion=1&ApplicationId=12&Device_UUID=Device1234&UserString=User |
6.1.2 POST new Immutable Session object
Url | [ThruWebServer]/REST/[version]/ImmutableSession |
|---|---|
Verb | POST |
Available starting from REST Service version | 1.3 |
Required HTTP Headers | Accept: (application/xml or application/json) |
Description | Verify user credentials and authenticate Thru user in the system with immutable session. Optionally passes external user information for audit purposes in UserString for the session opened. Device_UUID parameter is mandatory and can be set to any string. |
Request Body | ThruSessionRequest object |
Return Data Object | ThruPublicSession object |
Invocation Scenario(s) | Verify customer credentials |
Remarks | Example request: UserName=admin&Password=password& |
6.1.3 POST new Session object by Ticket
Url | [ThruWebServer]/REST/[version]/SessionByTicket |
|---|---|
Verb | POST |
Available starting from REST Service version | 1.2 |
Required HTTP Headers | Accept: (application/xml or application/json), Device_UUID |
Description | Verify user credentials and authenticate Thru user in the system with immutable session |
Request Body | ThruSessionByTicketRequest object |
Return Data Object | ThruPublicSession object |
Invocation Scenario(s) | Verify customer credentials |
Remarks | Example request: UserName=admin&Password=password& |
6.1.4 POST new Immutable Session object by Ticket
Url | [ThruWebServer]/REST/[version]/ImmutableSessionByTicket |
|---|---|
Verb | POST |
Available starting from REST Service version | 1.2 |
Required HTTP Headers | Accept: (application/xml or application/json), Device_UUID |
Description | Verify user credentials and authenticate Thru user in the system with immutable session |
Request Body | ThruSessionRequest object |
Return Data Object | ThruPublicSession object |
Invocation Scenario(s) | Verify customer credentials |
Remarks | Example request: UserName=admin&Password=password& |
6.1.5 DELETE Existing Session Object
Url | [ThruWebServer]/REST/[version]/Session |
|---|---|
Verb | DELETE |
Required HTTP Headers | Accept: (application/xml or application/json) |
Description | Logs out Thru customer from the system. |
Request Body | None |
Return Data Object | None |
Invocation Scenario(s) | Expire session object |
Logs out customer from the system | undefined |
Remarks |
6.1.6 CHECK Existing Session Object
Url | [ThruWebServer]/REST/[version]/Session |
|---|---|
Verb | GET |
Required HTTP Headers | Accept: (application/xml or application/json) |
Description | Check if customer is authenticated. |
Request Body | None |
Return Data Object | None |
Invocation Scenario(s) | Check session object |
Remarks |