Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleAvailability

This routine is available starting with  SIL Engine™ 4.8.0.11.

Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

Syntax

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

Package

or

admUpdateUser(userName, newEmail, newUserName)

or

...

adm

Alias

Pkg Usage

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

Description

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

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

Parameters

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

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.

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "jirauser_groupadmin_routine" and space = currentSpace ( )
labelsjiraarray_group_routineroutines