Skip to end of metadata
Go to start of metadata

Cprime Apps has been rebranded as Anova Apps. Please note the only effect is the company name - all of our products’ names, logos, functionalities, support, etc. is exactly the same. The new location to our documentation space is https://anovaapps.atlassian.net.

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

UsernameStringYesUsername of the user to be updated.
New EmailStringYesNew email to update for the user. An empty string can be passed if the email does not need to be updated.
New User NameStringNoNew username to update for the user. An empty string can be passed if the user name does not need to be updated.
New Display NameStringNoNew 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

See also

  • No labels