• management
• Management
• ConnectionOptionsLinkedin

Interface ConnectionOptionsLinkedin

Options for the 'linkedin' connection

interface ConnectionOptionsLinkedin {
non_persistent_attrs?: ConnectionNonPersistentAttrs;
client_id?: string;
client_secret?: string;
freeform_scopes?: ConnectionScopeArray;
scope?: ConnectionScopeArray;
set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum;
strategy_version?: number;
upstream_params?: ConnectionUpstreamParams;
basic_profile?: boolean;
email?: boolean;
full_profile?: boolean;
network?: boolean;
openid?: boolean;
profile?: boolean;
key: string: any;
}

Hierarchy (View Summary)

• ConnectionOptionsCommon
  • ConnectionOptionsLinkedin

Indexable

Accepts any additional properties

Index

Properties

non_persistent_attrs?client_id?client_secret?freeform_scopes?scope?set_user_root_attributes?strategy_version?upstream_params?basic_profile?email?full_profile?network?openid?profile?

Properties

Optionalnon_persistent_attrs

non_persistent_attrs?: ConnectionNonPersistentAttrs

Optionalclient_id

client_id?: string

Optionalclient_secret

client_secret?: string

Optionalfreeform_scopes

freeform_scopes?: ConnectionScopeArray

Optionalscope

scope?: ConnectionScopeArray

Optionalset_user_root_attributes

set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum

Optionalstrategy_version

strategy_version?: number

The strategy_version property determines which LinkedIn API version and OAuth scopes are used for authentication. Version 1 uses legacy scopes (r_basicprofile, r_fullprofile, r_network), Version 2 uses updated scopes (r_liteprofile, r_basicprofile), and Version 3 uses OpenID Connect scopes (profile, email, openid). If not specified, the connection defaults to Version 3.

Optionalupstream_params

upstream_params?: ConnectionUpstreamParams

Optionalbasic_profile

basic_profile?: boolean

Request the LinkedIn lite profile scope (r_liteprofile) to retrieve member id, localized first/last name, and profile picture. Off by default.

Optionalemail

email?: boolean

Request the email address scope (r_emailaddress) to return the member's primary email. Off by default.

Optionalfull_profile

full_profile?: boolean

Request the legacy full profile scope (r_fullprofile) for extended attributes. Deprecated by LinkedIn; use only if enabled for your app. Off by default.

Optionalnetwork

network?: boolean

Request legacy network access (first-degree connections). Deprecated by LinkedIn and typically unavailable to new apps. Off by default.

Optionalopenid

openid?: boolean

Request OpenID Connect authentication support (openid scope). When enabled, the connection will request the 'openid' scope from LinkedIn, allowing the use of OpenID Connect flows for authentication and enabling the issuance of ID tokens. This is off by default and should only be enabled if your LinkedIn application is configured for OpenID Connect.

Optionalprofile

profile?: boolean

Always-true flag that ensures the LinkedIn profile scope (r_basicprofile/r_liteprofile/profile) is requested.

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties non_persistent_attrsclient_idclient_secretfreeform_scopesscopeset_user_root_attributesstrategy_versionupstream_paramsbasic_profileemailfull_profilenetworkopenidprofile