administrator.md

title	isDefaultIndex	generated
Administrator	false	true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

Administrator

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.

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;
}

• Extends: VendureEntity

• Implements: SoftDeletable, HasCustomFields

constructor

<MemberInfo kind="method" type={(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>&#62;) => Administrator} />

deletedAt

<MemberInfo kind="property" type={Date | null} />

firstName

<MemberInfo kind="property" type={string} />

lastName

<MemberInfo kind="property" type={string} />

emailAddress

<MemberInfo kind="property" type={string} />

user

<MemberInfo kind="property" type={<a href='/reference/typescript-api/entities/user#user'>User</a>} />

customFields

<MemberInfo kind="property" type={CustomAdministratorFields} />