Endpoint URL: {socialLoginDomain} /api/v2/unmap
Description
Unmapping removes an Identity Provider from a primary key as well as allowing you to optionally unlink your application from the user's account with the provider.
It may be helpful to review the mappings call.
Read the Account Mapping overview topic to learn more.
Respects the API Client Allow List: No
Accepted Content-types
- application/x-www-form-urlencoded
- multipart/form-data
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.
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 removes the social login provider with the identifier 0987098709870987 from primary key 12.
curl -X POST \
--data-urlencode apiKey=1234567891234567891234567891234567891234 \
--data-urlencode identifier=0987098709870987 \
--data-urlencode all_identifiers=true \
--data-urlencode primaryKey=12 \
--data-urlencode unlink=true \
https://janrain-docs.rpxnow.com/api/v2/unmap
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 currently mapped to the primaryKey. |
all_identifiers | string | When true, all identifiers mapped to the primaryKey are removed. The default value is false. | |
primaryKey | string | Yes | Primary key found in the users table. |