IUserDetails

[ Interface ]

export interface IUserDetails {
    domain: string;
    enabled: boolean;
    autoLogout: string;
    locale?: string | null;
    timeFormatLocale?: string | null;
    timeZone?: string | null;
    groups: string[];
};

Saves metadata of a user.

Properties

Name

Type

Description

domain

string

User management domain. If this is not specified, the default specified below applies.

enabled

boolean

Specifies whether the user is active; true if not specified

autoLogout

string

Timespan as ISO 8601 timespan. String that indicates after what time 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.

groups

string[]

Groups in which the user is a member.

IUserDetails 1:

Available from version 1.10.1018.48

Behavior for new users

Each new user is by default at least a member of the "__SystemUsers" group and uses the language of the project. If no domain is specified, the extension TcHmiUserManagement is used for user management.

This behavior can be changed on the server configuration page under TcHmiSrv under the name "Default Usergroup" and "Default authentication extension".