Interface User

interface User {
    accountRootUserId: string;
    createdAt?: Date;
    deletable: boolean;
    email: string;
    firstName: string;
    id: string;
    lastLoginAt?: Date;
    lastName: string;
    locale: string;
    locked: boolean;
    mfa: boolean;
    organizationId: string;
    phoneNumber: string;
    status: UserStatus;
    tags: string[];
    twoFactorEnabled?: boolean;
    type: UserType;
    updatedAt?: Date;
    username: string;
}

Properties

accountRootUserId createdAt? deletable email firstName id lastLoginAt? lastName locale locked mfa organizationId phoneNumber status tags twoFactorEnabled? type updatedAt? username

Properties

accountRootUserId

accountRootUserId: string

ID of the account root user associated with the user.

OptionalcreatedAt

createdAt?: Date

Date user was created.

deletable

deletable: boolean

Deletion status of user. Owners cannot be deleted.

email

email: string

Email of user.

firstName

firstName: string

First name of the user.

id

id: string

ID of user.

OptionallastLoginAt

lastLoginAt?: Date

Date of the last login.

lastName

lastName: string

Last name of the user.

locale

locale: string

Locale of the user.

locked

locked: boolean

Defines whether the user is locked.

mfa

mfa: boolean

Defines whether MFA is enabled.

organizationId

organizationId: string

ID of the Organization.

phoneNumber

phoneNumber: string

Phone number of the user.

status

status: UserStatus

Status of user invitation.

tags

tags: string[]

Tags associated with the user.

OptionaltwoFactorEnabled

twoFactorEnabled?: boolean

Deprecated

Deprecated, use "mfa" instead.

type

type: UserType

Type of user.

OptionalupdatedAt

updatedAt?: Date

Date of last user update.

username

username: string

User identifier unique to the Organization.

Settings

On This Page

Properties