Method Detail

• abstract java.lang.String getAccountId()

  The account ID of the user, which uniquely identifies the user across all Atlassian products.

  Returns:

  the account ID of the user.

• abstract com.atlassian.jira.rest.clientv2.model.User$AccountTypeEnum getAccountType()

  The type of account represented by this user.

  Returns:

  the account type of the user.

• abstract java.lang.Boolean getActive()

  Whether the user is active.

  Returns:

  true if the user is active, false otherwise.

• abstract java.util.List<com.atlassian.jira.rest.clientv2.model.ApplicationRole> getApplicationRoles()

  The application roles the user is assigned to.

• abstract com.atlassian.jira.rest.clientv2.model.AvatarUrlsBean getAvatarUrls()

  The avatars of the user.

  Returns:

  the avatars of the user.

• abstract java.lang.String getDisplayName()

  The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.

  Returns:

  the display name of the user.

• abstract java.lang.String getEmailAddress()

  The email address of the user. Depending on the user’s privacy settings, this may be returned as null.

  Returns:

  the email address of the user.

• abstract EntityProperties getEntityProperties()

  Retrieves an EntityProperties object that acts as a proxy for interacting with the entity properties, allowing retrieval, setting, and deletion of properties.

  Returns:

  an EntityProperties object for managing user properties.

• abstract java.util.List<Group> getGroups()

  Retrieves all groups that the specified user is a member of.

  This method returns a list of Group objects representing every group the user associated with the given account ID belongs to. If the user is not a member of any group, the returned list will be empty.

  Note: Ensure you have the necessary permissions to view this user's group memberships. If the Jira REST API returns an error or the request fails, a GroupRetrievalException is thrown.

  Example Usage in Groovy:

  def user = Users.getByAccountId("5b10a2844c20165700ede21g")
   def groups = user.getGroups()
  
   groups.each { group ->
       println "Group Name: ${group.name, Group ID: ${group.groupId}"
   }
   }

  Returns:

  a list of Group objects representing the groups the user is a member of, or an empty list if none

• abstract java.lang.String getKey()

  This property is no longer available and will be removed from the documentation soon.

  Returns:

  the key of the user.

• abstract java.lang.String getLocale()

  The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

• abstract java.lang.String getName()

  This property is no longer available and will be removed from the documentation soon.

  Returns:

  the name of the user.

• abstract java.lang.String getSelf()

  The URL of the user.

  Returns:

  the URL of the user.

• abstract java.lang.String getTimeZone()

  The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.

  Returns:

  the time zone of the user.