diff options
| author | link0ff <juri@linkov.net> | 2019-03-14 17:43:30 +0200 |
|---|---|---|
| committer | link0ff <juri@linkov.net> | 2019-03-14 17:43:30 +0200 |
| commit | 54e7087ab412a488f8ad7286aef89d313e5e7b14 (patch) | |
| tree | 9391107eb5aec3940bf6150539acc38e85224751 /docs/Admin-API.md | |
| parent | 9338f061a303ae3d57a8ea1af524c2ca51929f8d (diff) | |
| parent | 59333f2d568dc6e50fb72e5114ec7dd6bcc1ebef (diff) | |
| download | pleroma-54e7087ab412a488f8ad7286aef89d313e5e7b14.tar.gz | |
Merge remote-tracking branch 'upstream/develop' into feature/openldap-support
Diffstat (limited to 'docs/Admin-API.md')
| -rw-r--r-- | docs/Admin-API.md | 35 |
1 files changed, 5 insertions, 30 deletions
diff --git a/docs/Admin-API.md b/docs/Admin-API.md index 407647645..2edb31f3c 100644 --- a/docs/Admin-API.md +++ b/docs/Admin-API.md @@ -7,36 +7,11 @@ Authentication is required and the user must be an admin. ### List users - Method `GET` -- Params: - - `page`: **integer** page number - - `page_size`: **integer** number of users per page (default is `50`) -- Response: - -```JSON -{ - "page_size": integer, - "count": integer, - "users": [ - { - "deactivated": bool, - "id": integer, - "nickname": string - }, - ... - ] -} -``` - -## `/api/pleroma/admin/users/search?query={query}&local={local}&page={page}&page_size={page_size}` - -### Search users by name or nickname - -- Method `GET` -- Params: - - `query`: **string** search term - - `local`: **bool** whether to return only local users - - `page`: **integer** page number - - `page_size`: **integer** number of users per page (default is `50`) +- Query Params: + - `query`: **string** *optional* search term + - `local_only`: **bool** *optional* whether to return only local users + - `page`: **integer** *optional* page number + - `page_size`: **integer** *optional* number of users per page (default is `50`) - Response: ```JSON |