Interface ConfluenceUser

  • All Superinterfaces:
    com.atlassian.user.Entity, Principal, RelatableEntity, Serializable, com.atlassian.user.User
    All Known Implementing Classes:
    ConfluenceUserImpl, DeferredLookupUser

    public interface ConfluenceUser
    extends com.atlassian.user.User, RelatableEntity
    Describing a Confluence user.

    A ConfluenceUser extends a "standard" user to have a fixed unique user key. This user key replaces 'username' as the canonical key to the User allowing username to be renamed if required.

    Since:
    5.2
    • Method Detail

      • getKey

        com.atlassian.sal.api.user.UserKey getKey()
        Return the immutable and unique key for the user.
        Returns:
        the unique key for this user.
      • getLowerName

        default @Nullable String getLowerName()
        Returns:
        the lower username
        Since:
        6.12.0