summaryrefslogtreecommitdiff
path: root/doc/api/users.md
diff options
context:
space:
mode:
authorDouwe Maan <douwe@gitlab.com>2018-02-14 10:40:59 +0000
committerDouwe Maan <douwe@gitlab.com>2018-02-14 10:40:59 +0000
commit6085656bffa54cdbe21e776e283f87ece313991f (patch)
tree0798db9f44217da4ff340ab66844673e5e189839 /doc/api/users.md
parent5e829934f95bcae25f5c09583b6febe6e2e646b6 (diff)
parentb7cd99c376c2f953f30a4bf982b69780e3d6985b (diff)
downloadgitlab-ce-6085656bffa54cdbe21e776e283f87ece313991f.tar.gz
Merge branch 'feature/include-custom-attributes-in-api' into 'master'
Allow including custom attributes in API responses See merge request gitlab-org/gitlab-ce!16526
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 2082e45756a..a4447e32908 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -165,6 +165,12 @@ You can filter by [custom attributes](custom_attributes.md) with:
GET /users?custom_attributes[key]=value&custom_attributes[other_key]=other_value
```
+You can include the users' [custom attributes](custom_attributes.md) in the response with:
+
+```
+GET /users?with_custom_attributes=true
+```
+
## Single user
Get a single user.
@@ -245,6 +251,12 @@ Parameters:
}
```
+You can include the user's [custom attributes](custom_attributes.md) in the response with:
+
+```
+GET /users/:id?with_custom_attributes=true
+```
+
## User creation
Creates a new user. Note only administrators can create new users. Either `password` or `reset_password` should be specified (`reset_password` takes priority).