Link APIs

    Overview

    This API has been available since 1.28.0

    This page contains the APIs that are used to manage Links that establish a relationship between a FusionAuth User and an Identity Provider.

    This API is used to create a link between a FusionAuth user and a user in a 3rd party identity provider. This API may be useful when you already know the unique Id of a user in a 3rd party identity provider and the corresponding FusionAuth user.

    Request

    Link a User

    URI

    POST /api/identity-provider/link

    Request Body

    displayName [String] Optional Available since 1.28.1

    A human readable name for this link. This value should be used to make it easier to identify the user this link represents in the remote identity provider.

    This value is optional and it will always be set by FusionAuth the next time this link is used to resolve the FusionAuth user during a login event for this IdP.

    identityProviderId [UUID] Required

    The Id of the identity provider. This identity provider must exist.

    identityProviderUserId [String] Required

    The Id for the User that is provided by the identity provider. This is the value that will allow FusionAuth to link this user on future logins. It is expected to be immutable.

    userId [UUID] Required

    The FusionAuth Id of the User that is being linked to the identity provider.

    Example Request JSON
    
{
  "displayName": "richard@piedpiper.com",
  "identityProviderId": "f50dbb83-4cc2-4e5e-aece-9efe068bddd9",
  "identityProviderUserId": "42",
  "userId": "fbf0e652-b2b5-45eb-b9c9-d4640889740b"
}

    Response

    Table 1. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    504

    One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files.

    Response Body

    identityProviderLink.displayName [String]

    A human readable name for this link for identification and convenience. This value will generally be an email address, or username. This value can be set by the API caller. So for instance, this value could be Initial piedpiper link from user migration. This value will be updated during the next login for the linked user based on the identify provider (richard@piedpiper.com, for instance). This value may not necessarily reflect the username or email you used to authenticate with the 3rd party identity provider.

    identityProviderLink.identityProviderId [UUID]

    The unique Id of the identity provider.

    identityProviderLink.identityProviderUserId [String]

    The Id for the User that is provided by the identity provider.

    identityProviderLink.userId [UUID]

    The FusionAuth User Id that is linked to the identity provider.

    Example Response JSON
    
{
  "identityProviderLink": {
    "displayName": "richard@piedpiper.com",
    "identityProviderId": "f50dbb83-4cc2-4e5e-aece-9efe068bddd9",
    "identityProviderUserId": "42",
    "insertInstant": 1623183147998,
    "lastLoginInstant": 1623183152224,
    "tenantId": "30663132-6464-6665-3032-326466613934",
    "userId": "fbf0e652-b2b5-45eb-b9c9-d4640889740b"
  }
}

    This API is used complete a pending link. If an identity provider is configured with a linking strategy of Create a pending link, a pendingLinkId will be returned by the Identity Provider API (see the Complete the Login section for each respective IdP). This value can be used in the request below.

    Request

    Complete a pending Link

    URI

    POST /api/identity-provider/link

    Request Body

    pendingIdPLinkId [String] Required

    The pending identity provider link id.

    userId [String] Required

    The Id of the User that is being linked to the identity provider

    Example Request JSON
    
{
  "pendingIdPLinkId": "elY3lKxvCQvsH_kfEMmBNLIl6TmydtCrNjHpFgVdxb8",
  "userId": "fbf0e652-b2b5-45eb-b9c9-d4640889740b"
}

    Response

    Table 2. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    504

    One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files.

    Response Body

    identityProviderLink.displayName [String]

    A human readable name for this link for identification and convenience. This value will generally be an email address, or username. This value can be set by the API caller. So for instance, this value could be Initial piedpiper link from user migration. This value will be updated during the next login for the linked user based on the identify provider (richard@piedpiper.com, for instance). This value may not necessarily reflect the username or email you used to authenticate with the 3rd party identity provider.

    identityProviderLink.identityProviderId [UUID]

    The unique Id of the identity provider.

    identityProviderLink.identityProviderUserId [String]

    The Id for the User that is provided by the identity provider.

    identityProviderLink.userId [UUID]

    The FusionAuth User Id that is linked to the identity provider.

    Example Response JSON
    
{
  "identityProviderLink": {
    "displayName": "richard@piedpiper.com",
    "identityProviderId": "f50dbb83-4cc2-4e5e-aece-9efe068bddd9",
    "identityProviderUserId": "42",
    "insertInstant": 1623183147998,
    "lastLoginInstant": 1623183152224,
    "tenantId": "30663132-6464-6665-3032-326466613934",
    "userId": "fbf0e652-b2b5-45eb-b9c9-d4640889740b"
  }
}

    This API is used to retrieve a single Link, all Links for a specific identity provider and user, or all Links for a user.

    Request

    Retrieve a single link

    URI

    GET /api/identity-provider/link?identityProviderId={identityProviderId}&identityProviderUserId={identityProviderUserId}&userId={userId}

    Request Parameters

    identityProviderId [UUID] Required

    The unique Id of the identity provider.

    identityProviderUserId [String] Required

    The unique user Id in the 3rd party identity provider. Ideally this value never change and will always uniquely identify the user in the 3rd party identity provider.

    userId [UUID] Optional

    The FusionAuth User Id that is linked to the identity provider. When this value is provided, a 404 status code will be returned if the link does not exist, or the link exists but is linked to a different userId. If you wish to identify if any user is linked, omit this parameter.

    Retrieve all links for a specific user by identity provider

    URI

    GET /api/identity-provider/link?identityProviderId={identityProviderId}&userId={userId}

    Request Parameters

    identityProviderId [UUID] Required

    The unique Id of the identity provider.

    userId [UUID] Required

    The FusionAuth User Id that is linked to the identity provider.

    Retrieve all links for a user

    URI

    GET /api/identity-provider/link?userId={userId}

    Request Parameters

    userId [UUID] Required

    The FusionAuth User Id that is linked to the identity provider.

    Response

    Table 3. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you requested doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    The response body for this API contains either a single Link or an array of Links. When you call this API with identityProviderId, identityProviderUserId, and optionally the userId, the response will contain a single Link. When you call this API with userId and either identityProviderId or identityProviderUserId, the response will contain an array of Links. All response types are defined below along with an example JSON response.

    identityProviderLink.displayName [String]

    A human readable name for this link. In most cases this value will be the username or email address of the user in the remote identity provider.

    identityProviderLink.identityProviderId [UUID]

    The unique Id of the identity provider.

    identityProviderLink.identityProviderUserId [String]

    The unique user Id in the 3rd party identity provider. Ideally this value never changes and will always uniquely identify the user in the 3rd party identity provider.

    identityProviderLink.insertInstant [Long]

    The instant that the Link was added to the FusionAuth database.

    identityProviderLink.lastLoginInstant [Long]

    The instant when the User logged in last with this identity provider using this link.

    identityProviderLink.tenantId [UUID]

    The Id of the Tenant that this User belongs to.

    identityProviderLink.token [String]

    The token returned from the identity provider. This is treated as an opaque token as the type varies by identity provider, this value may not be returned by all identity providers. When provided, this token is typically a long lived access or refresh token, but consult individual identity provider documentation for specifics.

    Note: Prior to version 1.28.0, this value can be retrieved using the User Registration APIs using the registration.token field.

    identityProviderLink.userId [UUID]

    The FusionAuth User Id that is linked to the identity provider.

    Example Response JSON
    
{
  "identityProviderLink": {
    "displayName": "richard@piedpiper.com",
    "identityProviderId": "f50dbb83-4cc2-4e5e-aece-9efe068bddd9",
    "identityProviderUserId": "42",
    "insertInstant": 1623183147998,
    "lastLoginInstant": 1623183152224,
    "tenantId": "30663132-6464-6665-3032-326466613934",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
    "userId": "fbf0e652-b2b5-45eb-b9c9-d4640889740b"
  }
}

    Response Body

    identityProviderLinks [Array]

    The list of Link objects.

    identityProviderLinks[x].displayName [String]

    A human readable name for this link. In most cases this value will be the username or email address of the user in the remote identity provider.

    identityProviderLinks[x].identityProviderId [UUID]

    The unique Id of the identity provider.

    identityProviderLinks[x].identityProviderUserId [String]

    The unique user Id in the 3rd party identity provider. Ideally this value never changes and will always uniquely identify the user in the 3rd party identity provider.

    identityProviderLinks[x].insertInstant [Long]

    The instant that the Link was added to the FusionAuth database.

    identityProviderLinks[x].lastLoginInstant [Long]

    The instant when the User logged in last with this identity provider using this link.

    identityProviderLinks[x].tenantId [UUID]

    The Id of the Tenant that this User belongs to.

    identityProviderLinks[x].token [String]

    The token returned from the identity provider. This is treated as an opaque token as the type varies by identity provider, this value may not be returned by all identity providers. When provided, this token is typically a long lived access or refresh token, but consult individual identity provider documentation for specifics.

    Note: Prior to version 1.28.0, this value can be retrieved using the User Registration APIs using the registration.token field.

    identityProviderLinks[x].userId [UUID]

    The FusionAuth User Id that is linked to the identity provider.

    Example Response JSON for a collection of Links
    
{
  "identityProviderLinks": [
    {
      "displayName": "richard@piedpiper.com",
      "identityProviderId": "f50dbb83-4cc2-4e5e-aece-9efe068bddd9",
      "identityProviderUserId": "42",
      "insertInstant": 1623183147998,
      "lastLoginInstant": 1623183152224,
      "tenantId": "30663132-6464-6665-3032-326466613934",
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI0MiIsIm5hbWUiOiJSaWNoYXJkIiwiaWF0IjoxNTE2MjM5MDIyfQ.hFtOTx0nZ58YNJlYLI9kV2Tt0Jg1yxdW7Gy-43V4clc",
      "userId": "fbf0e652-b2b5-45eb-b9c9-d4640889740b"
    },
    {
      "displayName": "richard@hooli.com",
      "identityProviderId": "363ae8d9-dd4d-4473-bdc6-3694f1d0329e",
      "identityProviderUserId": "9821123",
      "insertInstant": 1623183147998,
      "lastLoginInstant": 1623183152225,
      "tenantId": "30663132-6464-6665-3032-326466613934",
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI5ODIxMTIzIiwibmFtZSI6IlJpY2hhcmQiLCJpYXQiOjE1MTYyMzkwMjJ9.bGRRUQBhdg6kS4sjiWrR-7xrOa6A2MzI9QhWlDcNf-Y",
      "userId": "fbf0e652-b2b5-45eb-b9c9-d4640889740b"
    }
  ]
}

    This API is used to remove a link between a FusionAuth user and a 3rd party identity provider.

    Request

    Delete the Link with the given Id

    URI

    DELETE /api/identity-provider/link?identityProviderId={identityProviderId}&identityProviderUserId={identityProviderUserId}&userId={userId}

    Request Parameters

    identityProviderId [UUID] Required

    The unique Id of the identity provider.

    identityProviderUserId [String] Required

    The Id for the User that is provided by the identity provider. This is the value that will allow FusionAuth to link this user on future logins. It is expected to be immutable.

    userId [UUID] Required

    The FusionAuth User Id that is linked to the identity provider.

    Response

    This API does not return a JSON response body.

    Table 4. Response Codes
    Code Description

    200

    The request was successful. The response will be empty.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to delete doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    504

    One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files.

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    Have a question or comment to share?

    Visit the FusionAuth community forum.