Property Detail

• com.atlassian.jira.user.ApplicationUser loggedInUser

• com.atlassian.jira.user.ApplicationUser loggedInUser

Constructor Detail

• Users()

Method Detail

• static com.atlassian.jira.user.ApplicationUser create(java.lang.String username, java.lang.String emailAddress, java.lang.String displayName, @groovy.lang.DelegatesTo(value: UserCreateDelegate)
  groovy.lang.Closure<?> specification)

  Creates a new user.

  Users.create('jbloggs', 'joe@example.com', 'Joe Bloggs')
   

  You can further customise the creation process:

   import com.atlassian.jira.application.ApplicationKeys
  
   Users.create('jbloggs', 'joe@example.com', 'Joe Bloggs') {
       password = 'supersecretpassword'
       directoryId = 10001
       withApplicationAccess(ApplicationKeys.SERVICE_DESK)
       // etc
   }
   

  To sign up a user without setting a password:

   Users.create('jbloggs', 'joe@example.com', 'Joe Bloggs') {
       sendUserSignupEvent()
   }
   

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.UserCreationException if the user could not be created

  Parameters:

  username

  emailAddress

  displayName

  specification

  Returns:

  the newly created user

• static com.atlassian.jira.user.ApplicationUser getByKey(java.lang.String userKey)

  Retrieves an ApplicationUser by key

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.InvalidUserKeyException if no user can be found with this key

  Parameters:

  userKey - the key of the user to retrieve

  Returns:

  the user with matching key

• static com.atlassian.jira.user.ApplicationUser getByName(java.lang.String username)

  Retrieves an ApplicationUser by name

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.InvalidUsernameException if no user can be found with matching name

  Parameters:

  username - the name of the user to retrieve

  Returns:

  the user with matching name

• static com.atlassian.jira.user.ApplicationUser getLoggedInUser()

  Get the current logged in user, may be null

  Returns:

  the logged in user or null if no logged in user present

• <T> static T runAnonymously(java.util.concurrent.Callable<T> callable)

  Run an action with no logged in user, returning the result, example usage:

   def issue = Users.callAs(Users.getByName('username')) {
       Issues.create('SR', 'Task') {
           summary = 'Help'
       }
   }

  Parameters:

  callable - the action to run, which returns a result

  Returns:

  the result of the provided action

• <T> static T runAs(java.lang.String username, java.util.concurrent.Callable<T> callable)

  Run an action as a different user, returning the result, example usage:

   def issue = Users.callAs('username') {
       Issues.create('SR', 'Task') {
           summary = 'Help'
       }
   }

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.InvalidUsernameException if no user can be found with matching name

  Parameters:

  username - user to run the action as

  callable - the action to run, which returns a result

  Returns:

  the result of the provided action

• <T> static T runAs(com.atlassian.jira.user.ApplicationUser applicationUser, java.util.concurrent.Callable<T> callable)

  Run an action as a different user, returning the result, example usage:

   def issue = Users.callAs(Users.getByName('username')) {
       Issues.create('SR', 'Task') {
           summary = 'Help'
       }
   }

  Parameters:

  applicationUser - user to run the action as

  callable - the action to run, which returns a result

  Returns:

  the result of the provided action

• static void setLoggedInUser(java.lang.String username)

  Set the current logged in user by name

  throws:

  com.adaptavist.hapi.jira.issues.exceptions.InvalidUsernameException if no user can be found with matching name

  Parameters:

  username - name of user to be set as the logged in user

• static void setLoggedInUser(com.atlassian.jira.user.ApplicationUser applicationUser)

  Set the current logged in user

  Parameters:

  applicationUser - the user to be set as the logged in user