Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Endpoint ID:2001
Method:
Status
colourGreen
titlePOST
URL:

/user/authenticate

Request body:

JSON data with type of authentication (native or Facebook) along with data specific to type of authentication.

Required fields:
 authType “native”:

loginID

password

 authType “facebook”:

appID (Facebook AppID)

userID

updatedAccessToken

accessTokenExpires (UTC timestamp for when the access token expires)

Code Block
titleExample 1 – Native authentication:
{
	"authType": "native",
	"loginID": "mailbox@mailserver.com",
	"password": "password"
}
Code Block
titleExample 2 – Facebook authentication:
{
	"authType": "facebook"
	"appID": 987654321,
	"userID": 123456789,
	"updatedAccessToken": "...",
	"accessTokenExpires": "..."
}
Span
stylewhite-space:pre
Response body:

JSON data with key(s) for successfully authenticated account. The result will always hold the dialogportal™ master key and if the app making the request is configured to use a specific external key, this key is also included in the response. If authentication fails, the result is empty

See 1001: Create account for example data

Status codes:200

Successfully authenticated

 403

Invalid login

The following sub codes may be returned:

403.1Unknown loginID
403.2User has not been verified
403.3User is not active
403.4Incorrect password
403.7Facebook appID not recognised
403.8Facebook connection does not exist
403.9The Facebook userID was found but the connection does not have a dpKey