POST api/v1/Authentication/TokenLogin
Reauthenticates a user by their login token generated during a normal login.
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 reauthentication token
TokenAuthenticationName | Description | Type | Additional information |
---|---|---|---|
reAuthenticationToken |
Optionally procided when the user logs in by setting generateReAuthenticationToken to true |
string |
None. |
Request Formats
application/json, text/json
{ "reAuthenticationToken": "sample string 1" }
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
LoginDataName | 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
{ "Authenticated": true, "ReAuthenticationToken": "sample string 2", "Me": { "ID": "8ec1a795-8688-4430-9af2-53dc591dde9b", "FirstName": "sample string 2", "LastName": "sample string 3", "ImageURL": "sample string 4" }, "SessionToken": "sample string 3" }