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.
Using the User List macro
To add the User List macro to a page:
- In the Confluence editor, choose Insert > Other Macros
- Find and select the required macro
Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Autocomplete for links, files, macros and mentions.
To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of 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).
Parameter | Default | Description |
|---|---|---|
Group(s) | none | 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:
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:
Go to
> Add-ons- Select System from the drop down and search for the User Lister add-on
- Expand the add-on and enable the User Log In Listener module.
- 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}