GET api/Auth

Authorize with the Web API to retrieve a database token. This database token will need to be included in all your web api calls in a header called "Token". Required Headers: Database, Username, Password

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

AuthorizationResult

AuthorizationResult
NameDescriptionTypeAdditional information
HasError

boolean

None.

ErrorDetails

string

None.

ErrorType

string

None.

Token

string

None.

TokenExpiryTime

date

None.

CurrentUserId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "HasError": true,
  "ErrorDetails": "sample string 2",
  "ErrorType": "sample string 3",
  "Token": "sample string 4",
  "TokenExpiryTime": "2024-05-29T17:18:51Z",
  "CurrentUserId": "e2f3e8e6-c527-4ff4-b8d2-19343575e51d"
}