IPS_SetUserActive

 bool IPS_SetUserActive (string $User, bool $Active) 

Parameters

Returns

If the function succeeds, it returns TRUE, otherwise FALSE.

Description

The function activates or deactivates the user User. Only active users can log in. This way a user can be blocked temporarily without deleting the user. Newly created users are initially inactive (see IPS_CreateUser). Roles and permissions of the user are kept when deactivating.

This function is only available for licenses that include the RBAC feature (Permission Control). Otherwise it fails with "This function is only available for licenses with the RBAC feature enabled!". If there are more users than the license allows (10 users by default, the @admin user is not counted), it fails with "Your license is currently limited to 10 users. Please consider upgrading the license to more users!" (the number is the limit of the license).

The currently logged in user (see IPS_GetLoggedInUser) must be an administrator, i.e. the @admin user or a user with the @admin role. Otherwise the function fails with "Administrator permissions are required for this action!".

If the user does not exist, the function fails with "User with name '…' does not exist". The @admin user cannot be modified; trying to do so fails with "User @admin cannot be modified!".

Example

IPS_SetUserActive('anna', true);  // Activates the user