Transparent Logon has been developed as a back-end server with a front-end application to run the user interface. All communication between the back- and front end is implemented using a set of API’s. When appropriate, these API’s can also be used to be called directly. An example of when this may make sense is calling the API to maintain the cross reference automatically from the directory.

Cross Reference

Get list of cross Reference records: /api/mapping/getAll?page={pageid}&size={recordsperpage}
Authentication: Basic
Type: GET
Parameters: pageid, recordsperpage
Example: GET https://tlx10test.steltix.com:8080/api/mapping/getAll

Create Cross reference records: /api/mapping/
Authentication: Basic
Type: POST
Fields: email, mappedUsername, username
Example: POST https://tlx10test.steltix.com:8080/api/mapping/
Body: [{email: “EMAIL@mail.com”, mappedUsername: “JDEUSER”, username: “DOMAIN\USER1”}]

Delete Crossreference record: /api/mapping/{id}
Authentication: Basic
Type: DELETE
ID: received from /api/mapping/getAll
Example: https://tlx10test.steltix.com:8080/api/mapping/10

Delete Crossreference record: /api/mapping/{username}/{mappedUsername}
Authentication: Basic
Type: DELETE
Fields: username, mappedUsername
Example: https://tlx10test.steltix.com:8080/api/mapping/USER1/JDEUSER

Audit records

Get Login History records: /api/audit/logonHistory?page={pageid}&size={recordsperpage}
Authentication: Basic
Type: GET
Parameters: pageid, recordsperpage
Example: https://tlx10test.steltix.com:8080/api/audit/logonHistory?page=0&size=25

Purge Login History: /api/audit/clearLogonHistory
Authentication: Basic
Type: GET
Example: https://tlx10test.steltix.com:8080/api/audit/clearLogonHistory

Get Admin History records: /api/audit/administrativeActionHistory?page={pageid}&size={recordsperpage}
Authentication: Basic
Type: GET
Parameters: pageid, recordsperpage
Example: https://tlx10test.steltix.com:8080/api/audit/administrativeActionHistory?page=0&size=25

Purge Administrative History: /api/audit/clearAdministrativeActionHistory
Authentication: Basic
Type: GET
Example: https://tlx10test.steltix.com:8080/api/audit/clearAdministrativeActionHistory

Generic Configuration

Get TL all configuration settings: /api/configuration/getProperties/
Authentication: Basic
Type: GET
Example : https://tlx10test.steltix.com:8080/api/configuration/getProperties/

Update TL configuration: /api/configuration/updatePropertyValues/
Authentication: Basic
Type: PUT
Fields: any field that is returned from /api/configuration/getProperties/
Example: https://tlx10test.steltix.com:8080/api/configuration/updatePropertyValues/
Body: {TLMaxAllowedAttempts: “4”}

Instances

Get List of instances: /api/instance/getAll?page={pageid}&size={recordsperpage}
Authentication: Basic
Type: GET
Parameters: page, recordsperpage
Example: https://tlx10test.steltix.com:8080/api/instance/getAll

Create new instance: /api/instance
Authentication: Basic
Type: POST
Parameters: {identifier: “name”, port: “port”}
Example: https://tlx10test.steltix.com:8080/api/instance
Body: {identifier: “PY920”, port: “7090”}

Delete Instance: /api/instance/{Instancename}
Authentication: Basic
Type: DELETE
Fields: InstanceName as parameter from /api/instance/getAll
Example: https://tlx10test.steltix.com:8080/api/instance/PY920

Get Instance settings: /api/configuration/getProperties/{Instancename}
Authentication: Basic
Type: GET
Fields: InstanceName as parameter from /api/instance/getAll
Example: https://tlx10test.steltix.com:8080/api/configuration/getProperties/DV920

Update Instance Setting: /api/configuration/updatePropertyValues/DV920
Authentication: Basic
Type: PUT
Fields: any field that is returned from /api/configuration/getProperties/{Instancename}
Example: https://tlx10test.steltix.com:8080/api/configuration/updatePropertyValues/DV920
Body: {useSSL: “true”}