• Rank One Partner API Documentation

Rank One Partner API Version 1.0

You are currently viewing 'External Login ' page



Usage

POST /Auth/ExternalLogin

Content-Type

application/json

Description

Log into Rank One using an oauth token generated from an external provider.

Note

Put the access token generated from the Get Access Token endpoint (Auth/ValidateUser) in the request header field "Authorization" as "bearer ACCESS_TOKEN_HERE".

Example

Sample Body:

{

"externalType": See External Types,
"accessToken": Put the access token generated by the external provider here
}

Sample Response:

{

"access_token": "abcd415236evsaasc",
"token_type": "bearer",
"expires_in": "2678400",
"message": "",
"userID": "4f8df05c-0d35-4fe1-b772-62e15a03f910",
"accessLevel": See Access Levels,
"responseCode": See Response Codes
}

External Types

Value
Description
facebook
Fields required:
ID
First_Name
Last_Name
Email
google
Scopes required are:
https://www.googleapis.com/auth/plus.login
https://www.googleapis.com/auth/userinfo.email

Access Levels

Value
Description
0
Parent Account

Response Codes

Value
Description
1.0
Successful
9.9
Unknown exception