Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Current »

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.

 Extend the AuthToken Expiry

If you are using ResourceXpress SaaS please contact our support team at helpdesk@qedas.com.


If you are using ResourceXpress On-Prem then you will need to modify the “AuthTokenExpiry” value found in the web.config file.

On your ResourceXpress server navigate to the RX install location. By default, this is C:\inetpub\wwwroot.

Open the web.config file in your preferred text editor.

Find the “AuthTokenExpiry” option, under <appSettings>.
If this value does not exist, add the below line.

<add key="AuthTokenExpiry" value="1800" />

Update the value to your desired duration in seconds.

1800 = 30 minutes
86400 = 24 hrs
2678400 = 31 days
31536000 = 365 days



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

  • No labels