Associate a Primary Key with a Social Login Provider

Endpoint: URL: {socialLoginDomain} /api/v2/map

Description

Associates a primary key with a user's social identity.

Note. The mapping API enables sites to store each of the user's external identifiers along with the primary key of the site's user/account record on the Identity Cloud server. These values are then included on every call to auth_info where the social identifier has been previously mapped.

See the Account Mapping overview topic to learn more.

Respects the API Client Allow List: No

Authentication

This endpoint uses your social login API key for authentication. This key can be found on the Settings page of the Social Login Dashboard.

Accepted Content-types

application/x-www-form-urlencoded
multipart/form-data

Base URL

The base URL for this endpoint is your application domain followed by /api/v2; for example:

https://educationcenter.rpxnow.com/api/v2

You can find your application domain in the Social Login (Engage Dashboard) on the Settings page:

Example Request

This command associates a social login identity (the identifier) with the specified primaryKey. This enables you to associate a social login with an existing user profile.


curl -X POST \
  --data-urlencode apiKey=1234567891234567891234567891234567891234 \
  --data-urlencode identifier=0987098709870987 \
  --data-urlencode primaryKey=12 \
  https://janrain-docs.rpxnow.com/api/v2/map

Running this command in Postman

Example Response


{
  "stat": "ok"
}

Query Parameters

Parameter	Type	Required	Description
apiKey	string	Yes	Social Login API key. This key can be found on the Social Login Dashboard.
identifier	string	Yes	Identifier returned from the auth_info API call.
overwrite	string		When set to false, mappings are created only if the specified identifier does not already have a mapping. The default value is true.
primaryKey	string		Primary key found in the user profile.

How to Create an Authentication String

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it. For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Before you actually try your authentication string, make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.