Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
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

JIRA REST API: User search not working as documented

I'm trying to use the user search to find a user by display name:

Example URL: https://<jira-instance>/rest/api/2/user/search?query=Test

 

Response:

{ "errorMessages": [ "The username query parameter was not provided" ], "errors": {}}

 In order to make this work I also have to supply the `username` attribute which defeats the purpose of the user search.

 

As far as I can tel, this request should work according to the documentation here: https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-user-search/#api-rest-api-2-user-search-get

 

Am I doing something wrong here?

 

1 answer

1 accepted

0 votes
Answer accepted

Hi @Emil Berglind ,

Could you try this https://<jira-instance>/rest/api/2/user/search?username=Test 

That seems to work, thanks! So, is the query parameter not actually used for anything since if providing the username attribute you're effectively cancelling that out? And, the username attribute actually searches in the displayName as well?

@Emil Berglind - A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId or property is specified.

 

Kindly accept the answer so that the post can be marked as Solved. Thanks

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Published in Apps & Integrations

Send an Email or Publish to Confluence - What should you do with your release notes?

Background When you hear the words ‘Release notes’, almost always you think of an unsolicited email from a software vendor. But I am here to tell you that from our data, sending release notes via E...

241 views 1 2
Read article

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