Skip to content
Robert Klohr edited this page Dec 15, 2020 · 1 revision
  • Login

Accepts an account username and password, verifies them and provides an encrypted cookie that can be used to authenticate additional API transactions.

URL https://[instance-name]:[port]/SecurityService/Login
Method POST
Input Username (Text) Username for the Lockpath application account.
Password (Text) Password for the Lockpath application.
Output A cookie to establish sessions within the component services API.
Permissions The account that is used to log into the application must have access to the Lockpath API.
Users must also have appropriate permissions for any data they wish to access or manipulate.

Examples

In this example, cURL uses the –c option to store the encrypted cookie that is returned in a file. The cookie can be sent to authenticate all data manipulation commands in the ComponentService API with a single cURL command line switch (-b). The response sample includes both the header of the response (to view the cookie) and the XML response.

XML REQUEST (cURL)

curl -c cookie.txt -H "content-type: application/xml;charset=utf-8" -X POST -d
"<Login><username>username</username><password>password</password></Login>"
https://[instance-name]:[port]/SecurityService/Login

JSON REQUEST (cURL)

curl -c cookie.txt -H "content-type: application/json" -H "Accept: application/json" -X POST
-d "{ \"username\": \"user1\", \"password\": \"12345\" }"
https://[instance-name]:[port]/SecurityService/Login

Clone this wiki locally