Skip to main content

Administrator

Administrator​

@vendure/coreadministrator.entity.ts

An administrative user who has access to the Admin UI and Admin API. The specific permissions of the Administrator are determined by the assigned

Roles.
Signature
class Administrator extends VendureEntity implements SoftDeletable, HasCustomFields {
    constructor(input?: DeepPartial<Administrator>)
    @Column({ type: Date, nullable: true })
    deletedAt: Date | null;
    @Column() firstName: string;
    @Column() lastName: string;
    @Column({ unique: true })
    emailAddress: string;
    @OneToOne(type => User)
    @JoinColumn()
    user: User;
    @Column(type => CustomAdministratorFields)
    customFields: CustomAdministratorFields;
}

constructor​

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

deletedAt​

property
Date | null

firstName​

property
string

lastName​

property
string

emailAddress​

property
string

user​

property
User

customFields​

property
CustomAdministratorFields