Child pages
  • Userlister Macro
Skip to end of metadata
Go to start of metadata

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

On this page:

Usage with the Macro Browser

To insert the userlister macro into a page using the Macro Browser,

  1. Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
  2. Click the Macro Browser icon on the toolbar. The macro browser window will open.
  3. Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
  4. Click the desired macro.
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to add the macro onto the page.

(tick) You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.

Once you've found the userlister macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

What you need to type

What you will get



Parameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.

Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).








Use parameter name 'group' or 'groups' to specify one or more groups whose Confluence users you want to list, using a comma-separated list of group names. To see all users registered in a Confluence installation, specify an asterisk ('*') for this parameter's value.

Display Online/Offline Users



Specify 'true' to generate a list of online users. Specify 'false' to generate a list of offline users.


Listing all Users

Here is an example that lists all the users registered on your Confluence site.


Specifying a Group

Here is an example that lists the users that belong to the group 'my-staff'.


Listing Only Online Users

(info) In order to make this feature functional, a System Administrator needs to enable the User Log In Listener for your Confluence site.

Here is an example that lists all currently online users in the 'my-staff' group.


Error rendering macro 'excerpt-include'

User 'null' does not have permission to view the page.


Working with Macros
Configuring the userlister Macro in the Confluence Administrator's Guide

Take me back to the Wikis Help Guide.

  • No labels