admDeactivateUser

admDeactivateUser

 

Syntax

admDeactivateUser(username)

Package

adm

Alias

 

Pkg Usage

deactivateUser(username)

Description

De-activates a user (sets its active flag to 'false' or removes it from all groups associated to global login permissions).

Parameters

Parameter name

Type

Required

Description

Parameter name

Type

Required

Description

username

String

Yes

Username or key.

Return Type

Boolean (true/false)

Returns 'true' if operation succeeded and 'false' otherwise.

Example

admDeactivateUser("testuser");

See also

Need support? Create a request with our support team.

Copyright © 2005 - 2026 Appfire | All rights reserved.