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:
- From the editor toolbar, choose Insert
> Other Macros - 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
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:
|
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.
{userlister:groups=confluence-users|online=false}