diff options
| author | Sean McGivern <sean@mcgivern.me.uk> | 2016-11-09 17:13:21 +0000 |
|---|---|---|
| committer | Sean McGivern <sean@mcgivern.me.uk> | 2016-11-09 17:13:21 +0000 |
| commit | 2976ad40f83e97e5e3628c32db1a06edafe21a72 (patch) | |
| tree | a18a349437f717cf8907750ba9acf4129aab8f84 /doc | |
| parent | 0d73e491801e52b59293ffb5eec4e556ec54c735 (diff) | |
| parent | a0aaf93fe591215a7fc29a52ff6cbd38604c8dcb (diff) | |
| download | gitlab-ce-2976ad40f83e97e5e3628c32db1a06edafe21a72.tar.gz | |
Merge branch '23731-add-param-to-user-api' into 'master'
Add query param to filter users by 'external' & 'blocked' type on API
Closes #23731
See merge request !7109
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/users.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index a50ba5432fe..041df07c051 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -33,6 +33,18 @@ GET /users ] ``` +In addition, you can filter users based on states eg. `blocked`, `active` +This works only to filter users who are `blocked` or `active`. +It does not support `active=false` or `blocked=false`. + +``` +GET /users?active=true +``` + +``` +GET /users?blocked=true +``` + ### For admins ``` @@ -120,6 +132,8 @@ For example: GET /users?username=jack_smith ``` +You can search for users who are external with: `/users?external=true` + ## Single user Get a single user. |