User List Macro

The User List macro displays a list of Confluence users, based on their group membership. The macro can also indicate when users are online or offline. 

The User List macro can be quite memory hungry in sites with lots of users.  To prevent it causing out of memory errors in your site, we don't show this macro if there are more than 10,000 people in the groups specified. Your administrator can change this limit using the confluence.extra.userlister.limit system property.

Using the User List macro

To add the User List macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros
  2. Find and select the required macro

Speed it up with autocomplete: Type and the beginning of the macro name, to see a list of suggested macros. In this example we're inserting the cheese macro.

To edit an existing macro: Click the macro placeholder and choose Edit. This will open the macro details, so you can edit the macro parameters.


Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).






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

See this knowledge base page for more information about controlling which users can see the details of other users.

Display Online/Offline Users

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.

Wiki markup example

This example is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: userlister

Macro body: None.


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 system app 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 > Manage apps

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

Last modified on Aug 1, 2019

Was this helpful?

Provide feedback about this article
Powered by Confluence and Scroll Viewport.