POST User/authenticate

Authenticates a user and returns a user token.

Request Information

URI Parameters

None.

Body Parameters

AuthenticateRequest
NameDescriptionTypeAdditional information
userName

User's account username

string

Required

password

User's account password

string

Required

code

Security code

string

None.

Request Formats

application/json, text/json

Sample:
{
  "userName": "sample string 1",
  "password": "sample string 2",
  "code": "sample string 3"
}

application/xml, text/xml

Sample:
<AuthenticateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.User">
  <code>sample string 3</code>
  <password>sample string 2</password>
  <userName>sample string 1</userName>
</AuthenticateRequest>

Response Information

Resource Description

AuthenticateResponse
NameDescriptionTypeAdditional information
token

Access token

globally unique identifier

None.

code

API result code

integer

None.

error

API error message

string

None.

UserID

User ID

integer

None.

IsEmployee

IsEmployee

boolean

None.

expirationDateUtc

Expiration Date as UTC

date

None.

APIVersion

API Version

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "UserID": 1,
  "IsEmployee": true,
  "expirationDateUtc": "2024-07-16T04:45:00.3168132-07:00",
  "APIVersion": 4,
  "token": "3753f8e3-7eb8-4df3-b292-373195e1bfbf",
  "code": 200,
  "error": "sample string 2"
}

application/xml, text/xml

Sample:
<AuthenticateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.User">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">4</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 2</error>
  <IsEmployee>true</IsEmployee>
  <UserID>1</UserID>
  <expirationDateUtc>2024-07-16T04:45:00.3168132-07:00</expirationDateUtc>
  <token>3753f8e3-7eb8-4df3-b292-373195e1bfbf</token>
</AuthenticateResponse>