POST api/v1/Authentication/Login

Logs in a user

Request Information

URI Parameters

Name	Description	Type	Additional information
fields	Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned.	Collection of string	None.
suppressResponseCodes	Some applications do wonky things if error codes are used. Use this to force 200s to always return.	boolean	None.
APIKey	This is your unique key that identifies you as the developer of this app. Required for all calls.	string	None.
APIToken	This is the user's session token generated when you authenticate the user	string	None.

Body Parameters

The user's authentication information

AuthenticationInfo

Name	Description	Type	Additional information
userName		string	Required
password		string	Required
deviceName	Required if using generateReAuthenticationToken. Let's the user have a unique token per device.	string	None.
generateReAuthenticationToken	Signals to include a reauthentication token so you can reauthenticate a user without storing their username and password. Reauthentication Tokens last for 30 days to make them usable for mobile apps where users may go days or weeks without reopening the app.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "userName": "sample string 1",
  "password": "sample string 2",
  "deviceName": "sample string 3",
  "generateReAuthenticationToken": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoginData

Name	Description	Type	Additional information
Authenticated	Whether or not the user was authenticated	boolean	None.
ReAuthenticationToken	If the user set generateReAuthenticationToken to true, this will be populated, otherwise it's empty	string	None.
Me	Contains basic information about the user that just logged in	CurrentUser	None.
SessionToken	The token identifying the current authenticated user, it needs to be passed up with each call	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Authenticated": true,
  "ReAuthenticationToken": "sample string 2",
  "Me": {
    "ID": "9db464aa-9490-4af3-b6bd-f5766bb1ffc4",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "ImageURL": "sample string 4"
  },
  "SessionToken": "sample string 3"
}