summaryrefslogtreecommitdiff
path: root/doc/api/users.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/users.md')
-rw-r--r--doc/api/users.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/api/users.md b/doc/api/users.md
index a79d31d19fa..ff5bffa178f 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -132,6 +132,18 @@ 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
+```
+
+For example:
+
+```
+GET /users?extern_uid=1234567&provider=github
+```
+
You can search for users who are external with: `/users?external=true`
## Single user