@c8y/client/lib/src/user/IUser.d.ts

Client application programming interface to access the Cumulocity IoT-Platform REST services.

import { IIdentified } from '../core/index.js';
import { IUserGroupReferences } from '../user-group/index.js';
/** Description of IUser interface */
export interface IUser {
    /** Uniquely identifies a user */
    id?: string;
    /**
     * User name, unique for a given domain.
     * Max: 1000 characters. Whitespaces, slashes, +$: characters not allowed
     */
    userName: string;
    /**
     * The display name
     */
    displayName: string;
    /**
     * User password. Min: 6, max: 32 characters.
     * Only Latin1 chars allowed
     */
    password?: string;
    /** Link to this Resource */
    self?: string;
    /** True if user should reset password */
    shouldResetPassword?: boolean;
    /** Keeps a list of all user applications */
    applications?: IIdentified[];
    /** Keeps a list of custom properties */
    customProperties?: any;
    /** List of device permissions */
    devicePermission?: any;
    /** User email address. */
    email?: string;
    /** User activation status (true/false) */
    enabled?: boolean;
    /** User first name. */
    firstName?: string;
    /** User last name. */
    lastName?: string;
    /** User phone number. */
    phone?: string;
    /**  */
    lastPasswordChange?: string;
    /** The password strength */
    passwordStrength?: string;
    /**  */
    twoFactorAuthenticationEnabled?: boolean;
    /** List of role references */
    roles?: IUserRoleReference;
    supportUserEnabled?: boolean;
    groups?: IUserGroupReferences;
    [key: string]: any;
}
/** Description of IUserRoleReference interface */
export interface IUserRoleReference {
    /** List of role references */
    references: IIdentified[];
    /** Link to this Resource */
    self: string;
}
/** Description of IUserReferences interface */
export interface IUserReferences {
    /** List of user references */
    references: IUserReference[];
    /** Link to this Resource */
    self: string;
}
/** Description of IUserReference interface */
export interface IUserReference {
    /** A user resource being referenced */
    user: Partial<IUser>;
    /** Link to this Resource */
    self: string;
}
//# sourceMappingURL=IUser.d.ts.map