The User List macro displays a list of users registered in Confluence, based on their group membership.

Using the User List macro

To add the User List macro to a page:

Parameters

Parameter

Default

Description

Group(s)
(groups) 

none

Specify the group name. Specify multiple groups separated by a comma, or use * to show all users in Confluence.

Display Online/Offline Users
(online) 

All registered users

List online or offline users. Leave blank to show all users, irrespective of status.

Accepted values:

  • Unspecified – The macro will show all registered users.
  • true – The macro will show only online users.
  • false – The macro will show only offline users.

See below for information on how to configure this macro to display online / offline users.

Configuring the User List macro

In order to use the Display Online / Offline Users parameter to indicate whether users are currently logged in to Confluence, you will need to enable the User Log In Listener component in the add-on that provides this macro. You'll need Confluence Administrator permissions to do this.

To enable the Display Online/Offline Users filter in the User List macro:

  1. Go to
  2. Select System from the drop down and search for the User Lister add-on
  3. Expand the add-on and enable the User Log In Listener module.
  4. Restart Confluence for the change to take effect.

Code examples

The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. 

Macro name: userlister

Macro body: None.

Storage format example

  <ac:structured-macro ac:name="userlister">
    <ac:parameter ac:name="groups">confluence-users</ac:parameter>
    <ac:parameter ac:name="online">false</ac:parameter>
  </ac:structured-macro>

Wiki markup example

{userlister:groups=confluence-users|online=false}