Userlister Macro

The Userlister macro displays a list of users registered in Confluence.

Usage

What you need to type	What you will get
{userlister:groups=*}

Parameters

Parameter	Required?	Default	Description
groups	Y	none	Use parameter name 'group' or 'groups'. Specify one or more groups using a comma-separated list of group names. To see all users in all groups, specify an asterisk ('*').
online	N	none	Specify 'true' to generate a list of online users. Specify 'false' to generate a list of offline users.

Examples

Listing all Users

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

{userlister:groups=*}

Specifying a Group

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

{userlister:groups=my-staff}

Listing Only Online Users

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.

{userlister:groups=my-staff|online=true}

List of online users can be misleading

When the parameter 'online=true' is used, Confluence uses a context listener to generate the list of online users. A context listener is a J2EE term for something that listens for events in the application server. We listen for session open and close events, so a user is 'online' if they have a session on the application server. Some application servers don't correctly despatch close events for sessions – in these cases, the list of online users may be misleading.

Page tree