LinkedIn

Overview

This API has been available since 1.23.0

The LinkedIn identity provider type will use OAuth 2.0 to authenticate a user with LinkedIn. It will also provide a Login with LinkedIn button on FusionAuth’s login page that will direct a user to the LinkedIn login page. Additionally, after successful user authentication, this identity provider will either call LinkedIn’s /v2/userinfo API or their /v2/me and /v2/emailAddress APIs to load additional details about the user and store them in FusionAuth.

The email address returned by the LinkedIn API will be used to create or look up the existing user. Additional claims returned by LinkedIn can be used to reconcile the User to FusionAuth by using a LinkedIn Reconcile lambda. Unless you assign a reconcile lambda to this provider, only the email address will be used from the available claims returned by LinkedIn.

FusionAuth will also store the LinkedIn access_token returned from the login endpoint in the identityProviderLink object, in the identityProviderLink.token field. This object is accessible using the Link API.

The identityProviderLink object stores the token so that you can use it in your application to call LinkedIn APIs on behalf of the user if desired.

Prior to version 1.28.0, the token was stored in the UserRegistration object, in the tokens Map.

LinkedIn Identity Provider Scopes

LinkedIn has changed their API programs over time.

Depending on when you created your application in LinkedIn you may need to use a different set of scopes. LinkedIn had an older “compliance” program for signing in with LinkedIn that used their Profile API. The newer program is “Sign In with LinkedIn using OpenID Connect” and uses their UserInfo API to query for user details.

Prior to version 1.49.0 FusionAuth only supported the legacy program. The values to use in the scope parameter are r_emailaddress, which returns the user’s email and either r_liteprofile or r_basicprofile for the remaining user info.

The newer program will always the openid scope and profile for the user’s profile information and email for the user’s email.

You will need to upgrade to FusionAuth version 1.49.0 or later to use the LinkedIn identity provider with the newer OpenID Connect program.

Create the LinkedIn Identity Provider

Request

Create the LinkedIn Identity Provider

POST /api/identity-provider

The type in the request JSON is used to determine that you are managing the LinkedIn identity provider.

Request Body

identityProvider.applicationConfigurationMap<UUID, Object>

The configuration for each Application that the identity provider is enabled for.

identityProvider.applicationConfiguration[applicationId].buttonTextString

This is an optional Application specific override for the top level buttonText .

identityProvider.applicationConfiguration[applicationId].client_idString

This is an optional Application specific override for the top level client_id .

identityProvider.applicationConfiguration[applicationId].client_secretString

This is an optional Application specific override for the top level client_secret .

identityProvider.applicationConfiguration[applicationId].createRegistrationBooleanDefaults to true

Determines if a UserRegistration is created for the User automatically or not. If a user doesn’t exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.

identityProvider.applicationConfiguration[applicationId].enabledBooleanDefaults to false

Determines if this identity provider is enabled for the Application specified by the applicationId key.

identityProvider.applicationConfiguration[applicationId].scopeString

This is an optional Application specific override for the top level scope .

identityProvider.buttonTextStringrequired

The top-level button text to use on the FusionAuth login page for this Identity Provider.

identityProvider.client_idStringrequired

The top-level LinkedIn client id for your Application. This value is retrieved from the LinkedIn developer website when you set up your LinkedIn app.

identityProvider.debugBooleanDefaults to false

Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.

This is useful for debugging purposes, but is not intended to be left on during production. It should be enabled during integration or if you are experiencing an issue with this identity provider.

identityProvider.client_secretStringrequired

The top-level client secret to use with the LinkedIn Identity Provider when retrieving the long-lived token. This value is retrieved from the LinkedIn developer website when you set up your LinkedIn app.

identityProvider.enabledBooleanDefaults to false

Determines if this provider is enabled. If it is false then it will be disabled globally.

identityProvider.lambdaConfiguration.reconcileIdUUIDAvailable since 1.17.0

The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.

The specified Lambda Id must be of type LinkedInReconcile.

identityProvider.linkingStrategyStringDefaults to LinkByEmailAvailable since 1.28.0

The linking strategy to use when creating the link between the LinkedIn Identity Provider and the user.

The possible values are:

CreatePendingLink - Do not automatically link, instead return a pending link identifier that can be used to link to an existing user.
Disabled - Disables linking automatically. You must use the API to create links. Available since 1.37.0
LinkAnonymously - Always create a link based upon the unique Id returned by the identify provider. A username or email is not required and will not be used to link the user. A reconcile lambda will not be used in this configuration.
LinkByEmail - Link to an existing user based upon email. A user will be created with the email returned by the identity provider if one does not already exist.
LinkByEmailForExistingUser - Only link to an existing user based upon email. A user will not be created if one does not already exist with email returned by the identity provider.
LinkByUsername - Link to an existing user based upon username. A user will be created with the username returned by the identity provider if one does not already exist.
LinkByUsernameForExistingUser - Only link to an existing user based upon username. A user will not be created if one does not already exist with username returned by the identity provider.

When the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser and the email_verified claim is present on the response from the LinkedIn Identity Provider and the value is false a link will not be established and an error will be returned indicating a link cannot be established using an unverified email address.

identityProvider.scopeString

The top-level scope that you are requesting from LinkedIn.

identityProvider.tenantConfigurationMap<UUID, Object>Available since 1.32.0

The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCountObjectAvailable since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabledBooleanDefaults to falseAvailable since 1.32.0

When enabled, the number of identity provider links a user may create is enforced by maximumLinks .

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinksIntegerDefaults to 42Available since 1.32.0

The maximum number of links that a user can have for a particular identity provider. This configuration is specific to this IdP. So a user can have more links than this number, but for this particular IdP, the number of links will be limited and enforced.

identityProvider.typeStringrequired

This field must be set to LinkedIn.

Example LinkedIn Request JSON

{
  "identityProvider": {
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with LinkedIn",
    "client_id": "86b3nbfinbhrnl",
    "client_secret": "gAi3V7mC2LGzriQR",
    "debug": false,
    "enabled": true,
    "scope": "openid profile email",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type": "LinkedIn"
  }
}

Response

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.

Response Body