diff options
| author | kaniini <nenolod@gmail.com> | 2019-05-08 14:34:36 +0000 |
|---|---|---|
| committer | kaniini <nenolod@gmail.com> | 2019-05-08 14:34:36 +0000 |
| commit | c2efc689d11aff541a1851d9bb16954c7907d653 (patch) | |
| tree | b7bc5876873d8de83bdce72961897b5cbb852cc1 /docs/api | |
| parent | 289b8224ac97a873569255b97f7391c2389ac3dc (diff) | |
| parent | bfeb33e951c8997f33a0242fe69b8e669e3afe07 (diff) | |
| download | pleroma-c2efc689d11aff541a1851d9bb16954c7907d653.tar.gz pleroma-c2efc689d11aff541a1851d9bb16954c7907d653.zip | |
Merge branch 'feature/761-add-users-filtration' into 'develop'
Feature/761 add users filtration
Closes #761
See merge request pleroma/pleroma!1117
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/admin_api.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md index 8befa8ea0..2657d1243 100644 --- a/docs/api/admin_api.md +++ b/docs/api/admin_api.md @@ -8,15 +8,20 @@ Authentication is required and the user must be an admin. - Method `GET` - Query Params: - - *optional* `query`: **string** search term + - *optional* `query`: **string** search term (e.g. nickname, domain, nickname@domain) - *optional* `filters`: **string** comma-separated string of filters: - `local`: only local users - `external`: only external users - `active`: only active users - `deactivated`: only deactivated users + - `is_admin`: users with admin role + - `is_moderator`: users with moderator role - *optional* `page`: **integer** page number - *optional* `page_size`: **integer** number of users per page (default is `50`) -- Example: `https://mypleroma.org/api/pleroma/admin/users?query=john&filters=local,active&page=1&page_size=10` + - *optional* `tags`: **[string]** tags list + - *optional* `name`: **string** user display name + - *optional* `email`: **string** user email +- Example: `https://mypleroma.org/api/pleroma/admin/users?query=john&filters=local,active&page=1&page_size=10&tags[]=some_tag&tags[]=another_tag&name=display_name&email=email@example.com` - Response: ```JSON |