Users

Link social identity to user

Link authenticated user identity from a social platform to a Logto user.

The usage of this API is usually coupled with POST /connectors/:connectorId/authorization-uri. With the help of these pair of APIs, you can implement a user profile page with the link social account feature in your application.

Note: Currently due to technical limitations, this API does not support the following connectors that rely on Logto interaction session: @logto/connector-apple, @logto/connector-saml, @logto/connector-oidc and @logto/connector-oauth.

post/api/users/{userId}/identities

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/users/{userId}/identities
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

userIdstring required

The unique identifier of the user.

Request body

connectorIdstring required

The Logto connector ID.

connectorDataobject required

A json object constructed from the url query params returned by the social platform. Typically it contains code, state and redirectUri fields.

Response

A new identity is linked to the user.

object required

Changes

No recorded changes to this operation across all 8 revisions of this API.