ftos.identity.users.deactivate

IMPORTANT!  
Starting with v24.3.0, this is renamed from unauthorizeUser to ftos.identity.users.deactivate.

Sets the isAuthorized attribute of a system user record to False.

This is a business logic method for business service components.

Syntax

Copy 
function ftos.identity.users.deactivate(userName : string): boolean;
 
Parameter Type Description
userName string Value of the userName attribute of the system user record to be unauthorized.

Return Value

Returns False if a valid system user account has been unauthorized.

Examples

In this example, we set the isAuthorized attribute of the alex.jones user account to False.

Copy 
ftos.identity.users.deactivate('alex.jones');