It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

User mention Macro - REST API



I am trying to create a Confluence Page using REST API and mention some existing users. Do do this I am using this macro:

<ri:user ri:userkey="123456789"/>

It works perfectly, but I can only get my userkey. To get others I need to ask each one particularly or query database for which I don't have access.


I tried something like this:

<ri:user ri:user="user"/>


but I got:

{"statusCode":500,"data":{"authorized":false,"valid":true,"errors":[],"successful":false},"message":"java.lang.RuntimeException: com.atlassian.confluence.content.render.xhtml.XhtmlException: com.atlassian.confluence.content.render.xhtml.XhtmlException: Missing required attribute: {}username"}


Is there a way to mention a Confluence user using Rest API with only the user name (not user-key)?



2 answers

2 votes
Bill_Bailey Community Leader Mar 20, 2019

You are writing a user macro? If so you can try this code:

#set($userInfo = $userAccessor.getUserByName("$userEntry"))
<ri:user ri:userkey="$userInfo.key"/>

Where $userEntry is the user name you want is selected using the @Param XXXX|type=username

Hi Bill,


Thanks for the quick response.

Unfortunately I don't have System Administrator permissions for creating new macros.  I am curios if there is one already available like this one that requires the userkey.

Bill_Bailey Community Leader Mar 22, 2019

I am not aware of any. I guess it is time to bribe your admin to install user macros for you. ;-)

You could set up a local copy of Confluence where you can be an admin and do all your testing, so that your admin would just have to install the macro once it is done.

Hi Bill,

I am able to do the same thing but once I update the comment/description with this macro, no notification received by the mentioned user. 

But if I use @ symbol along with the user notification email working fine. Any idea?

Bill_Bailey Community Leader Jan 28, 2020

I suspect that the mention function is driven by a client-side script versus the server. In other words, the user macro will display a user name in a similar fashion, it won't trigger the mention script/autocomplete, driven by the shortcut the @ key.

However, all it not lost (maybe), as there is a user mention macro, so you could just use the storage format inside your user macro, and it should work.

Hi Bill,

How can I get the storage format? I got the source code as below:

      <ri:user ri:userkey="xxxxxxx" />

I have implemented this but it just shown the User. No notification.

Could you please help? 

0 votes
Radek Janata Community Leader Nov 07, 2019

Hi Orlando,

it's sufficient to use 'username' instead of 'userkey'. Confluence will transform it automatically from 'username' to 'userkey'.

<ri:user ri:username="name.surname"/>


Suggest an answer

Log in or Sign up to answer
Community showcase
Posted in Confluence

What project did you transition or start on Confluence with the shift to remote work?

It’s been great to hear from fellow users over the last few weeks about the best tips and fun moments you’ve had working on Confluence since the transition to working remote. I’d love to keep the c...

159 views 3 8
Join discussion

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you