3 Authentication is required and the user must be an admin.
5 ## `/api/pleroma/admin/users`
11 - *optional* `query`: **string** search term
12 - *optional* `filters`: **string** comma-separated string of filters:
13 - `local`: only local users
14 - `external`: only external users
15 - `active`: only active users
16 - `deactivated`: only deactivated users
17 - *optional* `page`: **integer** page number
18 - *optional* `page_size`: **integer** number of users per page (default is `50`)
19 - Example: `https://mypleroma.org/api/pleroma/admin/users?query=john&filters=local,active&page=1&page_size=10`
43 ## `/api/pleroma/admin/user`
50 - Response: User’s nickname
59 - Response: User’s nickname
61 ## `/api/pleroma/admin/users/:nickname/toggle_activation`
63 ### Toggle user activation
68 - Response: User’s object
78 ## `/api/pleroma/admin/users/tag`
80 ### Tag a list of users
87 ### Untag a list of users
94 ## `/api/pleroma/admin/permission_group/:nickname`
96 ### Get user user permission groups membership
104 "is_moderator": bool,
109 ## `/api/pleroma/admin/permission_group/:nickname/:permission_group`
111 Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
113 ### Get user user permission groups membership per permission group
121 "is_moderator": bool,
126 ### Add user in permission group
131 - On failure: `{"error": "…"}`
132 - On success: JSON of the `user.info`
134 ### Remove user from permission group
139 - On failure: `{"error": "…"}`
140 - On success: JSON of the `user.info`
141 - Note: An admin cannot revoke their own admin status.
143 ## `/api/pleroma/admin/activation_status/:nickname`
145 ### Active or deactivate a user
150 - `status` BOOLEAN field, false value means deactivation.
152 ## `/api/pleroma/admin/users/:nickname`
154 ### Retrive the details of a user
160 - On failure: `Not found`
161 - On success: JSON of the user
163 ## `/api/pleroma/admin/relay`
171 - On success: URL of the followed relay
179 - On success: URL of the unfollowed relay
181 ## `/api/pleroma/admin/invite_token`
183 ### Get a account registeration invite token
187 - Response: invite token (base64 string)
189 ## `/api/pleroma/admin/email_invite`
191 ### Sends registration invite via email
198 ## `/api/pleroma/admin/password_reset`
200 ### Get a password reset token for a given nickname
204 - Response: password reset token (base64 string)