Cumulocity Web SDK - v1022.44.7
    Preparing search index...

    Interface IUser

    Description of IUser interface

    interface IUser {
        applications?: IIdentified[];
        customProperties?: any;
        devicePermission?: any;
        displayName: string;
        email?: string;
        enabled?: boolean;
        firstName?: string;
        groups?: IUserGroupReferences;
        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
    Index

    Properties

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

    Properties

    applications?: IIdentified[]

    Keeps a list of all user applications

    customProperties?: any

    Keeps a list of custom properties

    devicePermission?: any

    List of device permissions

    displayName: string

    The display name

    email?: string

    User email address.

    enabled?: boolean

    User activation status (true/false)

    firstName?: string

    User first name.

    groups?: IUserGroupReferences
    id?: string

    Uniquely identifies a user

    lastName?: string

    User last name.

    lastPasswordChange?: string
    password?: string

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

    passwordStrength?: string

    The password strength

    phone?: string

    User phone number.

    roles?: IUserRoleReference

    List of role references

    self?: string

    Link to this Resource

    shouldResetPassword?: boolean

    True if user should reset password

    supportUserEnabled?: boolean
    twoFactorAuthenticationEnabled?: boolean
    userName: string

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

    Settings

    Member Visibility

    On This Page

    Properties