Page Comparison

Info

title	Availability

This routine is available starting with SIL Engine™ 4.8.0.11.

Table plus

applyColStyleToCell	true
heading	0
columnTypes	s,s,s,s
multiple	false
columnAttributes	style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSorting	false

Syntax

admUpdateUser(userName, newEmail[, newUserName, newDisplayName])

Package

or

admUpdateUser(userName, newEmail, newUserName)

or

...

adm
Alias		Pkg Usage	updateUser(userName, newEmail[, newUserName, newDisplayName])

Description

Excerpt

hidden	true

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

Parameters

Table plus

applyColStyleToCell	true
columnTypes	s,s,s,s
heading	0
multiple	false
enableSorting	false

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

...

.

Example

...

Code Block

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

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

Versions Compared

Old Version 1

New Version Current

Key