/map

Use the map to associate a primary key with a user's social identity.

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

Read the Account Mapping overview topic to learn more.

Accepted Content-types

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

This endpoint includes the following methods:

  • POST


POST

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

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


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 Janrain 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.