api_auth

<back to all web services

LoginThirdPartyRequest

The following routes are available for this service:
GET/api/login/{Provider}Creates a session between user and bit.pub web site, using information provided by trusted third party. Don't call this directly - third party will redirect to this url during OAuth process.
LoginThirdPartyRequest Parameters:
NameParameterData TypeRequiredDescription
ProviderpathstringYesTrusted provider. Facebook, Google and WindowsLive are supported
CodequerystringNoCode received from third party provider during OAuth process.
ErrorquerystringNoError received from third party provider during OAuth process.
RememberForquerystringNoPeriod to maintain a session between user and bit.pub web site. If not present - session with expire when user closes browser OR in 8 hours, whatever comes first. If present, this field should contain a number followed by min|hour|day|week|month|year (no spaces).
UserInfo Parameters:
NameParameterData TypeRequiredDescription
PersonIDformlongNo
NameformstringNo
EmailformstringNo
Telephoneformlong?No
HyperIDformstringNo
IsConfirmedformboolNo
IsEmailConfirmedformboolNo
IsTelephoneConfirmedformboolNo
IsAddressConfirmedformboolNo
IsPassportConfirmedformboolNo
DatacenterIDformbyteNo
SessionIDformlongNo
MailNodeIDformint?No
CanResendConfirmationformboolNo
LanguageformstringNo
ServerTimeformDateTimeNo
ExpirationTimeformDateTimeNoExpiration time of current session
UserAgentformUserAgentInfoNo
SessionKeyformstringNo
MinAuthLevelformintNo
SessionAuthLevelformintNo
UserAgentInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DeviceNameformstringNo
DeviceTypeformshortNo
OSTypeformshortNo
OSVersionformstringNo
BrowserNameformstringNo
BrowserVersionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/login/{Provider} HTTP/1.1 
Host: 1.hyper.id 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"personID":0,"name":"String","email":"String","telephone":0,"hyperID":"String","isConfirmed":false,"isEmailConfirmed":false,"isTelephoneConfirmed":false,"isAddressConfirmed":false,"isPassportConfirmed":false,"datacenterID":0,"sessionID":0,"mailNodeID":0,"canResendConfirmation":false,"language":"String","userAgent":{"name":"String","deviceName":"String","deviceType":0,"osType":0,"osVersion":"String","browserName":"String","browserVersion":"String"},"sessionKey":"String","minAuthLevel":0,"sessionAuthLevel":0}