Overview of LVS API Access tokens
TBD
Obtaining access token
Use the following endpoint to obtain the access token.
POST https://api.lvs.linius.com/v3/iam/auth/signin
Request Body:
{ "password": "string", "userName": "string"} |
Request Field Definition:
|
Field name
|
Type
|
Required?
|
Notes
|
|---|---|---|---|
password |
string | Yes | Password that you specified for your User Account during registration |
userName |
string | Yes | Username that you specified during registration |
Response Body:
{ "actionSession": null, "actionType": null, "expiresAt": "1518788954000", "refreshToken": "string", "signedIn": true, "token": "string", "userId": "string"} |
Response Field Definition:
|
Field name
|
Type
|
Notes
|
|---|---|---|
actionSession |
String | N/A |
actionType |
String | N/A |
expiresAt |
String | token expiration timestamp |
refreshToken |
String | Toekn that allows you to refresh session |
signedIn |
Boolean | True/False |
token |
String | Main authorization token needed in every API Call |
userId |
Integer | Internal user ID |
Refreshing authentication token
POST https://api.lvs.linius.com/v3/iam/auth/refresh
Specify plain refreshToken in Request Body.
Response is the same as in case of Sign-in. You will get new values of token and refreshToken
Validating authentication token
GET https://api.lvs.linius.com/v3/iam/auth/token/validate
Make a call to this endpoint with the following parameters in the header:
- authorization - keyword: Bearer + access token that will be available to you after successful sign-in, for example: Authorization = Bearer AuTheNtIcAtIoNtOkEn
As a response you will receive 200 status if token is valid or 401 status if token is invalid.
|
Additional Tools and Resources |
Comments
0 comments
Article is closed for comments.