User Functions

This section contains functions that enable users to handle users.

Functions summary

accountIdToDisplayName — Returns the display name for the provided user key.
currentUser — Returns the key for the user that invoked the script containing currentUser.
currentUserKey — Returns the key for the user that invoked the script containing currentUserKey.
currentUsername — Returns the username for the user that invoked the script containing currentUsername.
getAllUsers — Gets all the users. Active accounts only
getUser — Gets the user by username or key.
getUserByEmail — Gets the user by email address.
getUserByFullName — Gets the user by full name.
getUserPropertiesKeys — Retrieves a list of properties keys.
getUserProperty — Retrieves properties of users.
isAnyUserAuthenticated — Verifies if there is a logged in user.
isTeamLeader — Verifies if the specified user is a team leader on the project (if it is a component lead).
isUserInRole — Returns "true" if the user has a certain role on the specified project.
runAs — Assumes a user when running a script.
setUserProperty — Sets properties of users.
userCurrentDate — Returns the user current locale date
userEmailAddress — Returns the email address of the selected user. The email address may be needed to supply it to various external systems.
userExists — Verifies if the selected user is registered Jira user.
userFullName — Returns the full name (firstname, lastname) of the user.
userGroups — Returns the groups the selected user belongs to.
userHasAccessToComment — Verifies if a comment is visible for an user.
userInGroup — Verifies if the selected user is in the selected group(s).
userKeyToUsername — Returns the username for the provided user key.
userLanguage — Returns the language for an user.
usernameToAccountId — Returns the account id for the provided username.
usernameToUserKey — Returns the user key / account id for the provided username.
userRoles — Returns the roles of the provided user in the project.
usersInGroups — Returns a list of users common to all the specified groups.
usersInRole — Returns the users that corespond to a certain role on the specified project.
userTimezone — Returns the user time-zone.

Can’t find what you are looking for? There are many more user functions in the User Administration section.

Peacock