User Functions

This section contains functions that enable users to handle users.

Functions summary

userKeyToDisplayName — Returns the display name for the provided user key.
getUser — Gets the user by username or key.
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.
getAllActiveUsers — Returns a list of all active users in Jira.
getAllInactiveUsers — Returns a list of all inactive users in Jira.
getAllUsers — Returns a list of usernames for all active and inactive users in Jira.
userGroups — Returns the groups the selected user belongs to.
getUserByEmail — Gets the user by email address.
getUserByFullName — Gets the user by full name.
getUserDirectoryName — Returns the directory name the user belongs to.
getUserProperty — Retrieves properties of users.
hasPermission — Checks if a user has the specified permission.
hasUserProperty — Checks if the user has the given property set.
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).
isUserActive — Checks to see if the given user has an active (licensed) account.
isUserAdmin — Determines if a provided user has administration privileges in the current Jira environment.
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.
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.
userHasAccessToComment — Verifies if a comment is visible for an user.
userHasCoreAccess — Verifies if a user has access to the Jira Core application.
userHasServiceDeskAccess — Verifies if a user has access to the Jira Service Desk application.
userHasSoftwareAccess — Verifies if a user has access to the Jira Software application.
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.
userLocale — Returns the locale for a user.
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.