Home Reference Source
public class | source

LinkedinAuth

Extends:

Auth → LinkedinAuth

OAuth login using linkedin login provider

Requires passport-linkedin-oauth2 package.

Constructor Summary

Public Constructor
public

constructor(options: object)

Member Summary

Public Members
public

OAuth 2 Client ID

public

OAuth 2 Client Secret

public

proxy: *

Should it construct urls based on proxy headers.

Method Summary

Public Methods
public

install(app: *, prefix: *, passport: *)

Inherited Summary

From class Auth
public

Additional settings given to passport.authenticate.

public

Custom fields

public

Default error message to return instead of actual errors (security).

public

Default roles new registered users should assume.

public

This is a standard descriptor of this authentication mechanism that is publicly shared.

public

method: *

Authentication method name.

public

users: CachedCollection

Users collection.

public

async createProfileFromCredential(id: *, extra: {}): *

helper method that creates a profile object from a credential address

public

createUserFromProfile(profile: Profile): User

Helper method that creates an User object from a Profile

public

findUser(value: string): User | false

Helper method that finds an user based on a credential.

public

generateId(): *

public

handleUserLoginByProfile(username: string, profile: Profile, done: Function, req: Request)

Helper method for SSO type logins.

public abstract

install(app: ExpressApplication, prefix: string, passport: Passport)

Must be overridden to provide implementation of said authentication method.

public

loggedIn(redirect: boolean): ExpressMiddleware

Helper method that produces a middleware to handle successful logged in case.

Public Constructors

public constructor(options: object) source

Override:

Auth#constructor

Params:

NameTypeAttributeDescription
options object

see Auth class + additional options for email configuration.

Public Members

public linkedinClientID: * source

OAuth 2 Client ID

public linkedinClientSecret: * source

OAuth 2 Client Secret

public proxy: * source

Should it construct urls based on proxy headers.

Public Methods

public install(app: *, prefix: *, passport: *) source

Must be overridden to provide implementation of said authentication method.

Override:

Auth#install

Params:

NameTypeAttributeDescription
app *
prefix *
passport *