Complete social login

Completes a social login. To make this call, you must have a valid social login token received after a user successfully authenticates by using one of the identity providers you've enabled for your social login application. See Configure social login by using the Social Login Dashboard for more information on how to get social login tokens.

📘

Your API call must be a POST request with all parameters included in the body of the request. These parameters can't be passed as URL parameters.

Authentication

No authentication is required to call this operation.

Base URL

The base URL for this operation is your Identity Cloud Capture domain; for example:

https://educationcenter.us- dev.janraincapture.com

Your Capture domain (also known as a Registration domain) can be found in Console on the Manage Application page.

Examples

Example 1: Complete Social Authentication

This command uses the social login token 8cff5948c5476ba61b8b4b635cc84664bcd2d57d to complete a social login.

curl -X POST \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": "12345abcde12345abcde12345abcde12",
    "flow": "standard",
    "flow_version": "20190618143040022299",
    "locale": "en-US",
    "redirect_uri": "http://localhost",
    "response_type": "token",
    "registration_form": "socialRegistrationForm",
    "token": "8cff5948c5476ba61b8b4b635cc84664bcd2d57d"
  }' 
  https://my-app.janraincapture.com/oauth/auth_native

If the user doesn't exist in the Identity Cloud Registration database, the error response includes profile information from the IDP that can be used to register the user via a call to oauth/register_native. Only data defined in the form specified in the registration_form member will be returned in this error response.

Example 2: Merge Social Accounts

This command merges a new social login account with an existing user account. The existing account is referenced by the token parameter, and is the social login token assigned when the user logged on with that account. The new social login account is identified by the merge_token parameter, and is the social login token assigned when the user logged on by using the new account.

curl -X POST \
  --data-urlencode 'client_id=12345abcde12345abcde12345abcde12'\
  --data-urlencode 'flow=standard' \
  --data-urlencode 'flow_version=20190618143040022299'\
  --data-urlencode 'locale=en-US' \
  --data-urlencode 'redirect_uri=http://localhost' \
  --data-urlencode 'response_type=token' \
  --data-urlencode 'token=12ab34cd56ef78gh90ij12kl34mn56op78qr90st' \
  --data-urlencode 'merge_token=ab12cd34ef56gh78ij90kl12mn34op56qr78st78' \
  https://my-app.janraincapture.com/oauth/auth_native

Parameters

All parameters need to be configured as x-www-form-urlencoded body parameters.

Responses

200 OK

Successful Response

A successful response returns the user profile in the capture_user object along with an access_token or authorization_code depending on the response_type parameter set in the call. Note that is_new will reflect true if the user did not previously exist and you have thin_registration set to true.

{
  "capture_user": {
    "created": "2016-04-20 17:02:18.649505 +0000",
    "uuid": "67890def-6789-defg-6789-67890defgh67",
    // additional profile data...
  },
  "is_new": false,
  "stat": "ok",
  "access_token": "z0y98xv76u5t4rs3"
}

Error - User Not Yet Registered

The example error response below indicates that neither the user's social identity nor the email address returned by the provider are currently registered. You may proceed to register the user with the oauth/register_native call using the same social login token passed into the previous call. If your call included the registration_form parameter, the error response will include prereg_fields with data from the social provider's payload mapped to fields in your social registration form. Note that this error may still be encountered when thin_registration is set to true if the chosen social provider doesn't return an email address.

{
  "stat": "error",
  "code": 310,
  "error_description": "no such user",
  "error": "record_not_found",
  "request_id": "d9yrm9g7vfrh7bk3",
  "prereg_fields": {
    "firstName": "John",
    "middleName": null,
    "lastName": "Doe",
    "emailAddress": "johndoe@example.com",
    "displayName": "JohnDoe",
    "mobile": null,
    "optInRegistration": false,
    "gender": "",
    "birthdate": null,
    "phone": null,
    "addressStreetAddress1": null,
    "addressStreetAddress2": null,
    "addressCity": null,
    "addressPostalCode": null,
    "addressState": "",
    "addressCountry": ""
  }
}

Error - Email Address Already Registered

The example error response below indicates that the user's social identity is not currently registered but the email address returned by the provider matches an existing record. You may proceed to ask the user to authenticate through the existing account and then merge in the new social account by using the first social login token for the merge_token parameter in the next call. If the response indicates that the existing provider is capture, use the oauth/auth_native_traditional call; otherwise use auth_native again after getting a social login token for the existing account, which will be passed in the token parameter.

{
  "stat": "error",
  "code": 380,
  "error_description": "a user already exists with that email address",
  "error": "email_address_in_use",
  "request_id": "x4jdsa9mbajg7hsj",
  "existing_provider": "googleplus",
  "existing_display_name": "janedoe",
  "existing_photo": {
    "id": 10628,
    "value": "https://lh3.googleusercontent.com/fyd7jkgbnjLBX/AAAAAAAAAAI/AAAAAAAAAAA/hjsGTSDljl/photo.jpg?sz=400",
    "type": "other"
  },
  "existing_date_created": "2016-04-21 23:13:58.437196 +0000"
}

Error - Invalid Social Login Token

The example error response below indicates that the social login token passed into the call is invalid or expired.

{
  "stat": "error",
  "code": 200,
  "error_description": "invalid token",
  "error": "invalid_argument",
  "request_id": "zygzvaatua8ezk2v"
}

Error - Missing Required Parameters

The example error response below indicates that one of the required parameters for the call was not included. The error message describes which parameter is missing.

{
  "stat": "error",
  "code": 100,
  "error_description": "missing arguments: flow",
  "error": "missing_argument",
  "request_id": "uyeem84bmqmnjuu4"
}

Error - Invalid Flow Value

The example error response below indicates that the value provided for one or more of the flow, flow_version, or locale parameters is invalid. Flow versions are unique across environments, so check that the version value included in the call is for the correct environment (that is, your development or production application).

{
  "stat": "error",
  "code": 500,
  "error_description": "could not find a flow named 'standard' with version '12345abc-1234-abcd-1234-12345abcde12' and locale 'en-US'",
  "error": "unexpected_error",
  "request_id": "murynd7fhpysq6um"
}

Error - Invalid API Client Permissions

The example error response below indicates that the API client used to make the call isn't configured with the login_client feature.

{
  "stat": "error",
  "code": 403,
  "error_description": "This client does not support log in and registration.",
  "error": "permission_error",
  "request_id": "y3sthb9dey6mv65e"
}