Custom User Search

Find the users you've been looking for!

With the custom user search macro you are able to configure a customized search. You are also able to control the look of the results.

To embed a Custom User Search into a page, select it from the list of available macros. A configuration window will open and offer you several options to customize your search.

In the user search macro of the plug-in, an individual help text can be stored, which is displayed in the search slot of the macro. Instead of the text "Search for Users", the text can be adapted according to the application.


  1. User group(s)
    If you want this Custom User Search to only search for users assigned to certain user groups, type them in here. Let's say you want your users to be able to identify their appropriate administrator. You could then limit the search to a user group "confluence-administrators". Leave this field blank to search in all groups.
  2. Profile fields to search  
    If you leave the second field blank, all existing profile fields will be searched. In many cases this yields to many search results that are not really relevant. In our example you might want to limit the search to two fields: Username and department. This covers two use cases: Users who want to find out more about an admin they know the name of, and users who are searching for the responsible admin of a specific department.
  3. Displayed profile fields
    You'll want your search results to be clearly arranged so users are not overwhelmed by too much information. Select all of the profile fields that are important for your users at this point. Add a "column break" to display field contents side by side.

  4. Profile fields for filtering
    Sometimes a search will result in a long list of entries. In this case you can offer your users additional filters to narrow down their search. Select the profile fields you want to offer for filtering within the search results.

This is what a search result could look like. Users who are searching for a contact can type in their search term and narrow down the resulting list by using the additional filters. If configured in the profile editor, the Instant Messanger and Phone field will be clickable.

(info) Regardless of the profile fields you selected during configuration to be included in the results list, a profile picture, the full name and the email address will always be displayed.

More flexible searches

Search examples:

DescriptionSearch string
A profile field contains any termBerlin Washington
A profile field contains all termsBerlin AND Washington
A profile field starts with "Wash"Wash*
A profile field with any character
between "Wash" and "ngton"

Searching for languages

Maybe your admin set up your profile in a way that you can define which languages you speak. If so, you'll be able to select the languages from a list that offers all languages.

Let's assume, your colleagues all did the same. In their profiles you can see, which language they speak.

Let's assume further, that you want to find someone in your company who speaks a certain language. Maybe you need something translated, and it's a language that's not very common.

Certainly you can find those colleagues speaking that language via search, right? You can, and you always could. But before version 2.12 you had to do it in a rather technical way: you had to input the so called "user locale" in the search box. So for example for someone speaking English, you'd have to search for "en*", because the user locales look something like "en_US" or "en_UK". Not very intuitive, right?

Beginning with version 2.12 you simply enter the name of the language into the search box: If you search for someone speaking English, search for "english". If you seek for someone speaking French, search for "french". And a person who speaks french themselves and is looking for someone who can speak finnish, they will search for "finnois".

  • No labels

This content was last updated on 05/21/2019.

This content hasn't been updated in a while. That doesn't have to be a problem. Some of our pages live for years without becoming obsolete. Please click this link if you want us to update this page. Old content can be incorrect, misleading or outdated. Please get in contact with us via a form on this page, our live chat or via email with if you are in doubt, have a question, suggestion, or want changes from us.