3 Authentication is required and the user must be an admin.
5 ## `/api/pleroma/admin/users`
11 - `page`: **integer** page number
12 - `page_size`: **integer** number of users per page (default is `50`)
30 ## `/api/pleroma/admin/users/search?query={query}&local={local}&page={page}&page_size={page_size}`
32 ### Search users by name or nickname
36 - `query`: **string** search term
37 - `local`: **bool** whether to return only local users
38 - `page`: **integer** page number
39 - `page_size`: **integer** number of users per page (default is `50`)
57 ## `/api/pleroma/admin/user`
64 - Response: User’s nickname
73 - Response: User’s nickname
75 ## `/api/pleroma/admin/users/:nickname/toggle_activation`
77 ### Toggle user activation
82 - Response: User’s object
92 ## `/api/pleroma/admin/users/tag`
94 ### Tag a list of users
101 ### Untag a list of users
108 ## `/api/pleroma/admin/permission_group/:nickname`
110 ### Get user user permission groups membership
118 "is_moderator": bool,
123 ## `/api/pleroma/admin/permission_group/:nickname/:permission_group`
125 Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
127 ### Get user user permission groups membership
135 "is_moderator": bool,
140 ### Add user in permission group
145 - On failure: `{"error": "…"}`
146 - On success: JSON of the `user.info`
148 ### Remove user from permission group
153 - On failure: `{"error": "…"}`
154 - On success: JSON of the `user.info`
155 - Note: An admin cannot revoke their own admin status.
157 ## `/api/pleroma/admin/activation_status/:nickname`
159 ### Active or deactivate a user
164 - `status` BOOLEAN field, false value means deactivation.
166 ## `/api/pleroma/admin/relay`
174 - On success: URL of the followed relay
182 - On success: URL of the unfollowed relay
184 ## `/api/pleroma/admin/invite_token`
186 ### Get a account registeration invite token
190 - Response: invite token (base64 string)
192 ## `/api/pleroma/admin/email_invite`
194 ### Sends registration invite via email
201 ## `/api/pleroma/admin/password_reset`
203 ### Get a password reset token for a given nickname
207 - Response: password reset token (base64 string)