diff options
author | Markus Koller <markus.koller.ext@siemens.com> | 2017-12-22 18:54:55 +0300 |
---|---|---|
committer | Markus Koller <markus.koller.ext@siemens.com> | 2018-02-08 15:30:34 +0300 |
commit | b7cd99c376c2f953f30a4bf982b69780e3d6985b (patch) | |
tree | 1a808da75fbc90fc332765cbe338a6ede7335a7a /doc/api/users.md | |
parent | bb2478c205932429e7e519aaaf2d9b655aecf860 (diff) |
Allow including custom attributes in API responses
Diffstat (limited to 'doc/api/users.md')
-rw-r--r-- | doc/api/users.md | 12 |
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). |