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,

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

{userlister:groups=*}

Parameters

Parameter

Required?

Default

Description

Group(s)
(groups)

yes

none

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
(online)

no

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

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

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


RELATED TOPICS

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

Take me back to the Confluence User's Guide.