IUpdateUserDetails

[ Interface ]

Version 1.10

export interface IUpdateUserDetails {
    domain?: string;
    newName?: string;
    password?: string;
    enabled: boolean;
    autoLogout: string;
    locale: string;
    addGroups?: string[];
    removeGroups?: string[];
};

Version 1.12

export interface IUpdateUserDetails {
    domain?: string;
    newName?: string;
    password?: string;
    currentPassword?: string;
    enabled?: boolean;
    autoLogout?: string;
    locale?: string;
    timeFormatLocale?: string;
    timeZone?: string;
    addGroups?: string[];
    removeGroups?: string[];
};

Change details of the metadata of a user.

Starting with version 1.12, users who are not members of the administrator group can change some of their data themselves.

Properties

Name	Type	Description
domain [optional]	string	User management domain. 'TcHmiUserManagement' if not specified
newName	string	New name of the user.
password	string	New password of the user
currentPassword [optional] From version 1.12	string	Old user password. Required if a user wants to change his password himself.
enabled	boolean	Specifies whether the user is active; true if not specified
autoLogout	string	Timespan as ISO 8601 timespan string that indicates the time after which the user is logged out. Format: P[JY][MM][WW][TD][T[hH][mM]] Example: "`P30D`" for 30 days, "`P1DT12H`" for one day and 12 hours, "`PT30M`" for 30 minutes.
locale	string	Language settings of the user. Here, from version 1.10.1336.10, 'client' is valid for the browser language or 'project' for the project setting.
timeFormatLocale From version 1.10.1336.10	string	Language settings of the user for time/date representations. Here 'client' is valid for the language of the browser or 'project' for the project setting.
timeZone From version 1.10.1336.10	string	Time zone of the user for time/date representations. Here 'client' is valid for the language of the browser or 'project' for the project setting.
addGroups	string[]	Groups in which the user is to become a new member.
removeGroups	string[]	Groups in which the user is no longer to be a member.

	Available from version 1.10.1018.48