<a id="linkedin"></a>

# LinkedIn

<a id="backend-classes"></a>

## Backend classes

For Django, choose from these class paths for `AUTHENTICATION_BACKENDS`.
For other integrations, use the same class paths in the
framework-specific backend setting.

| Backend name             | Class path                                            |
|--------------------------|-------------------------------------------------------|
| `linkedin-openidconnect` | `social_core.backends.linkedin.LinkedinOpenIdConnect` |
| `linkedin-oauth2`        | `social_core.backends.linkedin.LinkedinOAuth2`        |
| `linkedin-mobile-oauth2` | `social_core.backends.linkedin.LinkedinMobileOAuth2`  |

Sign In with LinkedIn only support OpenID Connect since August 1, 2023. The previous
OAuth2 has been deprecated. See [LinkedIn OpenID Connect](https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin-v2) for more details.

LinkedIn previously supported OAuth2. Migration between each type is fairly
simple since the same Key / Secret pair is used for both authentication types.

LinkedIn OAuth2 setup is similar to any other OAuth2 service. The auth flow is
explained on [LinkedIn Developers](https://docs.microsoft.com/en-us/linkedin/shared/authentication/authentication) docs. First you will need to register an
app att [LinkedIn Developer Network](https://www.linkedin.com/secure/developer).

<a id="openid-connect"></a>

## OpenID Connect

- Fill the application key and secret in your settings:
  ```default
  SOCIAL_AUTH_LINKEDIN_OPENIDCONNECT_KEY = ''
  SOCIAL_AUTH_LINKEDIN_OPENIDCONNECT_SECRET = ''
  ```

<a id="oauth2"></a>

## OAuth2

- Fill the application key and secret in your settings:
  ```default
  SOCIAL_AUTH_LINKEDIN_OAUTH2_KEY = ''
  SOCIAL_AUTH_LINKEDIN_OAUTH2_SECRET = ''
  ```
- Application scopes can be specified by:
  ```default
  SOCIAL_AUTH_LINKEDIN_OAUTH2_SCOPE = [...]
  ```

  Check the available options at [LinkedIn Scopes](https://docs.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin) (also called as permissions
  by LinkedIn). If you want to request a user’s email address, you’ll need
  specify that your application needs access to the email address use the
  `r_emailaddress` scope.
- To request extra fields using [LinkedIn fields selectors](https://docs.microsoft.com/en-us/linkedin/shared/references/v2/profile/lite-profile) just define this
  setting:
  ```default
  SOCIAL_AUTH_LINKEDIN_OAUTH2_FIELD_SELECTORS = [...]
  ```

  with the needed fields selectors, also define
  `SOCIAL_AUTH_LINKEDIN_OAUTH2_EXTRA_DATA` properly, that way the values will
  be stored in `UserSocialAuth.extra_data` field. By default `id`,
  `firstName` and `lastName` are requested and stored.

For example, to request a user’s email from the Linkedin API and store the
information in `UserSocialAuth.extra_data`, you would add these settings:

```default
# Add email to requested authorizations.
SOCIAL_AUTH_LINKEDIN_OAUTH2_SCOPE = ['r_liteprofile', 'r_emailaddress']
# Add the fields so they will be requested from linkedin.
SOCIAL_AUTH_LINKEDIN_OAUTH2_FIELD_SELECTORS = ['emailAddress']
# Arrange to add the fields to UserSocialAuth.extra_data
SOCIAL_AUTH_LINKEDIN_OAUTH2_EXTRA_DATA = [('id', 'id'),
                                          ('firstName', 'first_name'),
                                          ('lastName', 'last_name'),
                                          ('emailAddress', 'email_address')]
```

Looks like LinkedIn is forcing the definition of the callback URL in the
application when OAuth2 is used. Follow the setup 1 carefully as per [Linkedin
App Setup](https://docs.microsoft.com/en-us/linkedin/shared/authentication/authorization-code-flow) to add a redirect url/callback url. Be sure to set the proper
values, otherwise a `(400) Client Error: Bad Request` might be returned by
their service.