Skip to end of banner
Go to start of banner

admDeactivateUser

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Availability

This routine is available starting with katl-commons 2.5.18 for Jira 5.x/ 2.6.10 for Jira 6.x.

Syntax

admDeactivateUser(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

usernameStringYesUsername or key.

Return type

boolean

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

Example

admDeactivateUser("testuser");

 

See also


  • No labels