admUpdateUser

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™ 4.8.0.11.

Syntax

admUpdateUser(userName, newEmail)

or

admUpdateUser(userName, newEmail, newUserName)

or

admUpdateUser(userName, newEmail, newUserName, newDisplayName])

Description

Updates the email, user name, or full name for a given user.

Parameters

Parameter name	Type	Required	Description
Username	String	Yes	Username of the user to be updated.
New Email	String	Yes	New email to update for the user. An empty string can be passed if the email does not need to be updated.
New User Name	String	No	New username to update for the user. An empty string can be passed if the user name does not need to be updated.
New Display Name	String	No	New display/full name to update for the user.

Return type

Boolean

Returns "true" if operation succeeded.

Note

This routine will only work for users in the internal Jira directory.

Example 1

admUpdateUser("jsmith", "john.smith@company.com"); //updates email only

//or

admUpdateUser("jsmith", "john.smith@company.com", "johnsmith"); //updates email and username

//or

admUpdateUser("jsmith", "john.smith@company.com", "johnsmith", "John Smith"); //updates email, username, and display name

//or

admUpdateUser("jsmith", "", "johnsmith", "John Smith"); //updates username and display name only

//or

admUpdateUser("jsmith", "", "", "John Smith"); //updates display name only

//or

admUpdateUser("jsmith", "", "johnsmith"); //updates username only