The Login API allows users to generate an AuthToken, this can be used with other APIs to securely access available information.
The Login public API was added in v2022.2 - April 2022
A valid user account with ResourceXpress will be required to use this API.
The user's Role will determine which APIs they are granted access to.
Once you have successfully received the AuthToken, store this value for use with other APIs.
Take note of the expiry date, by default, the AuthToken will expire after 30 minutes.
Using the API
Request Type
POST
Request URL
https://<rx-server>/api/Public/Login
Headers (required)
{
'X-Requested-With': 'com.resourcexpress.report'
}
Body (required)
{
'EmailId': '<your-rx-email-address>',
'Password': '<your-rx-password>'
}
Example Response
{
"UserId": <your-id>,
"UserName": "<your-name>",
"AuthToken": "9a841c01-****-****-****-4fd27be665c7",
"BeaconUid": null,
"TenantURL": "<your-server-address>",
"ExpiresOn": "2022-04-06T12:52:27.526509+00:00",
"ErrCode": "",
"ErrDesc": "",
"Response": true
}
Postman Examples