Commit ddae884c authored by Rémy Coutable's avatar Rémy Coutable

Merge branch '38095-change-api-docs-lookup-by-username' into 'master'

Resolve "Change API docs to reflect that lookup by username does not require admin access"

Closes #38095

See merge request gitlab-org/gitlab-ce!20646
parents 3cc6a46d ab659da6
...@@ -33,6 +33,20 @@ GET /users ...@@ -33,6 +33,20 @@ GET /users
] ]
``` ```
You can also search for users by email or username with: `/users?search=John`
In addition, you can lookup users by username:
```
GET /users?username=:username
```
For example:
```
GET /users?username=jack_smith
```
In addition, you can filter users based on states eg. `blocked`, `active` In addition, you can filter users based on states eg. `blocked`, `active`
This works only to filter users who are `blocked` or `active`. This works only to filter users who are `blocked` or `active`.
It does not support `active=false` or `blocked=false`. It does not support `active=false` or `blocked=false`.
...@@ -126,21 +140,7 @@ GET /users ...@@ -126,21 +140,7 @@ GET /users
] ]
``` ```
You can search for users by email or username with: `/users?search=John` You can lookup users by external UID and provider:
In addition, you can lookup users by username:
```
GET /users?username=:username
```
For example:
```
GET /users?username=jack_smith
```
You can also lookup users by external UID and provider:
``` ```
GET /users?extern_uid=:extern_uid&provider=:provider GET /users?extern_uid=:extern_uid&provider=:provider
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment