admDeactivateUser

Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !

Availability

This routine is available starting with SIL Engine™ 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