JIRA REST API: User search not working as documented

[Deleted user]

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?

[Niranjan · Accepted solution]

Hi @[deleted] ,

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

[Deleted user]

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?

[Niranjan]

@[deleted] - 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