Authenticate a social login

post https://{hostname}/api/v2/auth_info

Authenticates a social login user.

Responses

Response body

object

stat

string

Indicates the status of the current operation.

OK ERROR FAIL

profile

object

Fields that make up the user's profile. This data is represented in the standard Portable Contacts schema.

verifiedEmail

string

User's verified email address.

googleUserId

string

User's unique Google identifier.

displayName

string

User's display name.

preferredUsername

string

User's preferred name, nickname, or the name that the user wants to be known by.

url

string

URL to the user's online social identity profile.

providerName

string

Name of the user's social identity provider.

identifier

string

URL identifier.

string

User's email address.

name

object

User's name information.

accessCredentials

object

If the user logged in with a provider that allows account access following authentication, this value contains the user's authorization credentials. The properties of this object can vary depending on the social login identity provider.

scopes

string

Scopes associated with the user.

oauthToken

string

OAuth access token issued by the social identity provider.

type

string

Type of token issued by the social login identity provider.

oauthTokenSecret

string

Secret associated with the OAuth token.

merged_poco

object

User's Portable Contacts object.

preferredUsername

string

User's preferred name, nickname, or the name that the user wants to be known by.

languagesSpoken

array of strings

Languages spoken by the user.

languagesSpoken

name

object

Name information for the user.

urls

array of objects

URLs assigned to the user.

urls

object

type

string

Type of URL.

value

string

URL.

emails

array of objects

Email accounts for the user.

emails

object

type

string

Type of email account.

value

string

Email address.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/api/v2/auth_info \
# Add Authorization header to this snippet
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded'


xxxxxxxxxx
47
}
1
{
2
  "stat": "ok",
3
  "profile": {
4
    "verifiedEmail": "sam@example.com",
5
    "googleUserId": "123456789123456789123",
6
    "displayName": "sam",
7
    "preferredUsername": "sam",
8
    "url": "https://www.google.com/profiles/123456789123456789123",
9
    "providerName": "Google",
10
    "identifier": "https://www.google.com/profiles/123456789123456789123",
11
    "email": "sam@example.com",
12
    "name": {
13
      "givenName": "Sam",
14
      "familyName": "Knot",
15
      "formatted": "Sam Knot"
16
    }
17
  },
18
  "accessCredentials": {
19
    "scopes": "Blogger,Google Buzz,Google Contacts,YouTube,Picasa Web Albums,Google Calendar,Google Docs",
20
    "oauthToken": "1/1234567891234567891234567891234567891234567",
21
    "type": "OAuth",
22
    "oauthTokenSecret": "123456789123456789123456"
23
  },
24
  "merged_poco": {
25
    "preferredUsername": "Sam",

200Successful response

400Parameters are missing or invalid.