Auth0 Node.js SDK - v5.5.0
    Preparing search index...

    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)

    Indexable

    • [key: string]: any

      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

    non_persistent_attrs?: ConnectionNonPersistentAttrs
    client_id?: string
    client_secret?: string
    freeform_scopes?: ConnectionScopeArray
    scope?: ConnectionScopeArray
    set_user_root_attributes?: Management.ConnectionSetUserRootAttributesEnum
    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.

    upstream_params?: ConnectionUpstreamParams
    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.

    email?: boolean

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

    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.

    network?: boolean

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

    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.

    profile?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties