Add a social login provider to a user profile

Associates a social login identity provider with a user account. See Map social login accounts for more information.


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.


This operation uses your social login API key for authentication. This key can be found on the Settings page of the Social Login dashboard. See Get started for more information.

Accepted content types

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

Base URL

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

You can find your application domain in the Social Login dashboard on the Settings page:

Example request

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

curl -X POST \
  --data-urlencode apiKey=1234567891234567891234567891234567891234 \
  --data-urlencode identifier="" \
  --data-urlencode primaryKey=12 \

Example response

If your API call succeeds the responses consists of the status ok:

  "stat": "ok"


aoiKeystringSocial login secret for authenticating the operation. To verify your API key, log in to Console and, on the Manage Application page, check the value of the rpx_key setting. This value also appears on the Settings page in the Social Login dashboard.
identifierstringUnique returned from the social login provider.
overwritebooleanIf false, the operation creates a new mapping if the specified identifier doesn't already have one. If the specified identifier already has a mapping that mapping is left alone and isn't overwritten.

If true, new mappings are created as needed and the operation overwrites existing mappings with new values.
primaryKeystringIndex number of the attribute.