User List Macro

Add the User List macro to a page to display a list of Confluence users, in a particular group. The macro can also indicate when users are online or offline. 

This is a legacy macro, and can cause performance issues in very large sites. We recommend you don't use this macro to attempt to show all users in a site.

On this page:

Screenshot: A page containing two User List macros.

Limitations

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.

Add this macro to your page

To add the User List macro to a page:

  1. From the editor toolbar, select Insert , then Other Macros.
  2. Choose User List from the Confluence content category.
  3. Enter the group you want to display.
  4. Choose Insert

You can then publish your page to see the macro in action. 

Screenshot: Configuring the User List macro to show the members of a group. 

Change the macro parameters

Macro parameters are used to change the behavior of a macro.

To change the macro parameters:

  1. In the editor, click the macro placeholder and select Edit.
  2. Update the parameters as required then select Insert.

Here's a list of the parameters available in this macro. 

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.

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

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.

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).

Other ways to add this macro

Add this macro as you type

Type followed by the start of the macro name, to see a list of macros. 

Add this macro using wiki markup

This 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}
Last modified on Jun 30, 2020

Was this helpful?

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