admUpdateUser
Syntax | admUpdateUser(userName, newEmail[, newUserName, newDisplayName]) | Package | adm |
Alias |
| Pkg Usage | updateUser(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.
Example
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 onlyThis function will only work for users in the internal Jira directory.