Unlink a social identity

Unlink a social identity
Open Recipe

Unlinks a social provider from a user account. Once unlinked, the social provider can't be used to sign into that account.

To make this call, you need to have a valid Registration access token for the user record being updated. Note that your API call must be a POST request with all parameters included in the body of the request.


Authentication

No authentication is required to call this endpoint.


Base URL

The base URL for this endpoint is your Identity Cloud Capture domain. For example:

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

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


Examples

Example: Unlink a social provider

This command unlinks a social login account (identifier by the provider method) from a user profile .

curl -X POST \
    --data-urlencode 'client_id=12345abcde12345abcde12345abcde12'\
    --data-urlencode 'flow=standard'\
    --data-urlencode 'flow_version=20190618143040022299'\
    --data-urlencode 'locale=en-US'\
    --data-urlencode 'access_token=z0y98xv76u5t4rs3'\
    --data-urlencode 'identifier_to_remove=http://www.example.com/profile/1234567890'\
    'https://my-app.janraincapture.com/oauth/unlink_account_native'

Methods

MethodData typeRequiredDescription
access_tokenstringRegistration access token returned after authentication or registration.
client_idstringAPI client ID used to authenticate the call. This client must be configured with the login_client feature, which gives it permission to use login and registration-based API operations.
flowstringName of the flow configured with the login experience you want to use. You can find a list of valid flow names using the Configuration API. Note that you can omit this method if you configure the flow name in the default_flow_name setting for the API client used in making this call.
flow_versionstringVersion number of the flow set in the flow method. Note that you can't set the flow version to HEAD, which instructs Identity Cloud of use the recent version of a flow. Instead, you must specify the version number . You can find a list of versions for your flow using the Configuration API. This method can be omitted if you you configure the flow version in the default_flow_version setting for the API client used to make this call.
identifier_to_removestringIdentifier URL for the social account you want to unlink. You can find available social identifier URLs for a user record by making an /entity API call and filtering for the profiles.identifier attribute.
localestringCode for the language you want to use for the profile management experience. The default locale provisioned with the standard Registration flow is en-US. Other locales must be configured in your flow. You can find a list of valid locales for your flow using the Configuration API.

Responses

200: Successful response

A successful call returns this response:

{
  "stat": "ok"
}

413: Invalid registration access token

Indicates that the Registration access token passed into the call is invalid or has expired.

{
    "stat": "error",
    "code": 413,
    "error_description": "invalid access token",
    "error": "invalid_access_token",
    "request_id": "9xmecweny6bxt5n2"
}

100: Missing required methods

Indicates that one of the required methods for the call was not omitted. The error message describes which method is missing. For example, this error notes that the flow argument couldn't be found:

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

500: Invalid flow value

Indicates that the value provided for the flow, flow_version, or locale methods is invalid. Flow versions are unique across environments, so verify that the version value included in the call is the correct version number for your environment:

{
  "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"
}

403: Invalid API client permissions

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"
}