Skip to main content

User

User​

@vendure/coreuser.entity.ts

A User represents any authenticated user of the Vendure API. This includes both Administrators as well as registered Customers.

Signature
class User extends VendureEntity implements HasCustomFields, SoftDeletable {
    constructor(input?: DeepPartial<User>)
    @Column({ type: Date, nullable: true })
    deletedAt: Date | null;
    @Column()
    identifier: string;
    @OneToMany(type => AuthenticationMethod, method => method.user)
    authenticationMethods: AuthenticationMethod[];
    @Column({ default: false })
    verified: boolean;
    @ManyToMany(type => Role)
    @JoinTable()
    roles: Role[];
    @Column({ type: Date, nullable: true })
    lastLogin: Date | null;
    @Column(type => CustomUserFields)
    customFields: CustomUserFields;
    @OneToMany(type => AuthenticatedSession, session => session.user)
    sessions: AuthenticatedSession[];
    getNativeAuthenticationMethod() => NativeAuthenticationMethod;
    getNativeAuthenticationMethod(strict?: boolean) => NativeAuthenticationMethod | undefined;
    getNativeAuthenticationMethod(strict?: boolean) => NativeAuthenticationMethod | undefined;
}

constructor​

method
(input?: DeepPartial<User>) => User

deletedAt​

property
Date | null

identifier​

property
string

authenticationMethods​

property
AuthenticationMethod[]

verified​

property
boolean

roles​

property
Role[]

lastLogin​

property
Date | null

customFields​

property
CustomUserFields

sessions​

property
AuthenticatedSession[]

getNativeAuthenticationMethod​

method
() => NativeAuthenticationMethod

getNativeAuthenticationMethod​

method
(strict?: boolean) => NativeAuthenticationMethod | undefined

getNativeAuthenticationMethod​

method
(strict?: boolean) => NativeAuthenticationMethod | undefined