diff options
author | Rémy Coutable <remy@rymai.me> | 2018-07-17 08:34:34 +0000 |
---|---|---|
committer | Rémy Coutable <remy@rymai.me> | 2018-07-17 08:34:34 +0000 |
commit | ddae884c1a5c7786a05ba7ce27ce9ea6bc09c4e5 (patch) | |
tree | 341aee20de24ca212d0f7df5ae7f02b918f2d3f3 | |
parent | 3cc6a46dc6808c49f93cdcc0c6d0f87b2faf7441 (diff) | |
parent | ab659da6d40a46d3b422105c836567bce03c45a5 (diff) | |
download | gitlab-ce-ddae884c1a5c7786a05ba7ce27ce9ea6bc09c4e5.tar.gz |
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
-rw-r--r-- | doc/api/users.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index ca5afa04687..72fdaaa2c74 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -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` This works only to filter users who are `blocked` or `active`. It does not support `active=false` or `blocked=false`. @@ -126,21 +140,7 @@ GET /users ] ``` -You can 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 -``` - -You can also lookup users by external UID and provider: +You can lookup users by external UID and provider: ``` GET /users?extern_uid=:extern_uid&provider=:provider |