IApiAccessResultObject

[ Interface ]

    export interface IApiAccessResultObject extends TcHmi.IResultObject {
        result?: {
            addUser: {
                general: boolean;
                enable: boolean;
                locale: boolean;
                timeFormatLocale: boolean;
                timeZone: boolean;
                autoLogoff: boolean;
                groups: boolean;
            };
            listUserNames: {
                general: boolean;
            };
            listUsers: {
                general: boolean;
                enabled: boolean;
                locale: boolean;
                timeFormatLocale: boolean;
                timeZone: boolean;
                autoLogoff: boolean;
                groups: boolean;
            };
            listUserGroups: {
                general: boolean;
                enabled: boolean;
                fileAccess: boolean;
                files: boolean;
                symbolAccess: boolean;
                symbols: boolean;
            };
            listUsersInGroup: {
                general: boolean;
            };
            removeUser: {
                general: boolean;
            };
            updateUser: {
                general: boolean;
                newName: boolean;
                addGroups: boolean;
                removeGroups: boolean;
                enabled: boolean;
                autoLogout: boolean;
                locale: boolean;
                timeFormatLocale: boolean;
                timeZone: boolean;
                changeOwnPassword: boolean;
                changePassword: boolean;
            };
        };
    }
}

Result of a getApiAccess call.

This interface extends TcHmi.IResultObject.

Properties

Name	Type	Description
result [optional]	Dictionary<Dictionary<boolean>>	Lists all current user management functions with their parameters. `general` here denotes the general functionality of the respective API.

	Available from version 1.12