Skip to main content
 
 
 
BluINFO

Authenticate

Overview 

Authenticates the API user and returns a Token that is required for all subsequent calls for the remainder of the session.

Request Information


Method

POST - api/Account/Authenticate

URI Parameters

Body Parameters

APICredentialViewModel

Name Description Type Additional information
Email

 

string

None.

Password

 

string

None.

JSON

{
  "Email": "sample string 1",
  "Password": "sample string 2"
}

XML

<APICredentialViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Models">
  <Email>sample string 1</Email>
  <Password>sample string 2</Password>
</APICredentialViewModel>

Response Information 


Resource Description

UserToken

Name Description Type Additional information
Email

 

string

None.

IsAuthenticated

 

boolean

None.

Token

 

string

None.

Response Formats 

JSON

{
  "Email": "sample string 1",
  "IsAuthenticated": true,
  "Token": "sample string 3"
}

XML

<UserToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Models">
  <Email>sample string 1</Email>
  <IsAuthenticated>true</IsAuthenticated>
  <Token>sample string 3</Token>
</UserToken>
  • Was this article helpful?