Interface IUser

Description of IUser interface

interface IUser {
    applications?: IIdentified[];
    customProperties?: any;
    devicePermission?: any;
    displayName: string;
    email?: string;
    enabled?: boolean;
    firstName?: string;
    id?: string;
    lastName?: string;
    lastPasswordChange?: string;
    password?: string;
    passwordStrength?: string;
    phone?: string;
    roles?: IUserRoleReference;
    self?: string;
    shouldResetPassword?: boolean;
    supportUserEnabled?: boolean;
    twoFactorAuthenticationEnabled?: boolean;
    userName: string;
    [key: string]: any;
}

Indexable

  • [key: string]: any

Properties

applications? customProperties? devicePermission? displayName email? enabled? firstName? id? lastName? lastPasswordChange? password? passwordStrength? phone? roles? self? shouldResetPassword? supportUserEnabled? twoFactorAuthenticationEnabled? userName

Properties

Optionalapplications

applications?: IIdentified[]

Keeps a list of all user applications

OptionalcustomProperties

customProperties?: any

Keeps a list of custom properties

OptionaldevicePermission

devicePermission?: any

List of device permissions

displayName

displayName: string

The display name

Optionalemail

email?: string

User email address.

Optionalenabled

enabled?: boolean

User activation status (true/false)

OptionalfirstName

firstName?: string

User first name.

Optionalid

id?: string

Uniquely identifies a user

OptionallastName

lastName?: string

User last name.

OptionallastPasswordChange

lastPasswordChange?: string

Optionalpassword

password?: string

User password. Min: 6, max: 32 characters. Only Latin1 chars allowed

OptionalpasswordStrength

passwordStrength?: string

The password strength

Optionalphone

phone?: string

User phone number.

Optionalroles

roles?: IUserRoleReference

List of role references

Optionalself

self?: string

Link to this Resource

OptionalshouldResetPassword

shouldResetPassword?: boolean

True if user should reset password

OptionalsupportUserEnabled

supportUserEnabled?: boolean

OptionaltwoFactorAuthenticationEnabled

twoFactorAuthenticationEnabled?: boolean

userName

userName: string

User name, unique for a given domain. Max: 1000 characters. Whitespaces, slashes, +$: characters not allowed

Settings

Member Visibility

On This Page

Properties