Feature #32090

REST API: users: add support for status=*

Added by Martin von Wittich about 2 years ago. Updated 7 months ago.

Status:ResolvedStart date:
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:REST API
Target version:-
Resolution:

Description

Currently, the /users.:format REST API will default to status=1 (active), that is, when you attempt to search for a certain user (redmine-admin.auth contains an API token of an administrator in the format -u TOKEN:x):

curl -H 'Content-Type: application/json' \
  -G -K redmine-admin.auth \
  'https://redmine.example.com/users.json?name=firstname.lastname'

it will only return the requested account when the account is active. This means that I have to make two request for status=1 and status=3 to find a user when I don't know if the account is locked or not :(

I would have suspected that status=* would return all kinds of users, similarly to how it works for Rest Issues with status_id=*, but this is apparently not the case.

History

#1 Updated by Go MAEDA about 2 years ago

You can get users with any status by adding 'status=' parameter.

curl --user admin:password 'http://redmine.example.com/users.json?status='

#2 Updated by Martin von Wittich about 2 years ago

  • Status changed from New to Resolved

Go MAEDA wrote:

You can get users with any status by adding 'status=' parameter.

That does exactly what I wanted, thanks! I've updated the wiki accordingly.

#3 Updated by Martin von Wittich about 2 years ago

Hm, there is one other issue I've stumbled over - users.json?name=foobar&status= won't return the status of the matched users. I either have to query the statuses separately (users.json?name=foobar&status=1 and so on) so I know that all matched users have the status I just queried, or I have to query each returned user separately with users/<id>.json to get the user's status. Is that intentional, or could a status field be added to users.:format?

#4 Updated by Yar n 7 months ago

This is so extremly not obvious.
Is it possible to update documentation to point to that feature?

Also available in: Atom PDF