AuthenticationMethod

@vendure/core Source

An AuthenticationMethod represents the means by which a User is authenticated. There are three kinds: NativeAuthenticationMethod, ExternalAuthenticationMethod and $ApiKeyAuthenticationMethod.

Signature

class AuthenticationMethod extends VendureEntity {    @Index()    @ManyToOne(type => User, user => user.authenticationMethods)    user: User;}

Extends: VendureEntity

user

propertyUser

ExternalAuthenticationMethod

@vendure/core Source

This method is used when an external authentication service is used to authenticate Vendure Users. Examples of external auth include social logins or corporate identity servers.

Signature

class ExternalAuthenticationMethod extends AuthenticationMethod {    constructor(input: DeepPartial<ExternalAuthenticationMethod>)    @Column()    strategy: string;    @Column()    externalIdentifier: string;    @Column('simple-json')    metadata: any;}

Extends: AuthenticationMethod

strategy

propertystring

externalIdentifier

propertystring

metadata

propertyany

NativeAuthenticationMethod

@vendure/core Source

This is the default, built-in authentication method which uses a identifier (typically username or email address) and password combination to authenticate a User.

Signature

class NativeAuthenticationMethod extends AuthenticationMethod {    constructor(input?: DeepPartial<NativeAuthenticationMethod>)    @Column()    identifier: string;    @Column({ select: false }) passwordHash: string;    @Column({ type: 'varchar', nullable: true })    verificationToken: string | null;    @Column({ type: 'varchar', nullable: true })    passwordResetToken: string | null;    @Column({ type: 'varchar', nullable: true })    identifierChangeToken: string | null;    @Column({ type: 'varchar', nullable: true })    pendingIdentifier: string | null;}

Extends: AuthenticationMethod

identifier

propertystring

passwordHash

propertystring

verificationToken

propertystring | null

passwordResetToken

propertystring | null

identifierChangeToken

propertystring | null

A token issued when a User requests to change their identifier (typically an email address)

pendingIdentifier

propertystring | null

When a request has been made to change the User's identifier, the new identifier will be stored here until it has been verified, after which it will replace the current value of the identifier field.

AuthenticationMethod

An AuthenticationMethod represents the means by which a User is authenticated. There are three kinds: NativeAuthenticationMethod, ExternalAuthenticationMethod and $ApiKeyAuthenticationMethod.

Signature

class AuthenticationMethod extends VendureEntity {    @Index()    @ManyToOne(type => User, user => user.authenticationMethods)    user: User;}

user

propertyUser

ExternalAuthenticationMethod

This method is used when an external authentication service is used to authenticate Vendure Users. Examples of external auth include social logins or corporate identity servers.

Signature

class ExternalAuthenticationMethod extends AuthenticationMethod {    constructor(input: DeepPartial<ExternalAuthenticationMethod>)    @Column()    strategy: string;    @Column()    externalIdentifier: string;    @Column('simple-json')    metadata: any;}

strategy

propertystring

externalIdentifier

propertystring

metadata

propertyany

NativeAuthenticationMethod

This is the default, built-in authentication method which uses a identifier (typically username or email address) and password combination to authenticate a User.

Signature

class NativeAuthenticationMethod extends AuthenticationMethod {    constructor(input?: DeepPartial<NativeAuthenticationMethod>)    @Column()    identifier: string;    @Column({ select: false }) passwordHash: string;    @Column({ type: 'varchar', nullable: true })    verificationToken: string | null;    @Column({ type: 'varchar', nullable: true })    passwordResetToken: string | null;    @Column({ type: 'varchar', nullable: true })    identifierChangeToken: string | null;    @Column({ type: 'varchar', nullable: true })    pendingIdentifier: string | null;}

identifier

propertystring

passwordHash

propertystring

verificationToken

propertystring | null

passwordResetToken

propertystring | null

identifierChangeToken

propertystring | null

A token issued when a User requests to change their identifier (typically an email address)

pendingIdentifier

propertystring | null