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/user/follow`
62 ### Make a user follow another user
66 - `follower`: The nickname of the follower
67 - `followed`: The nickname of the followed
71 ## `/api/pleroma/admin/user/unfollow`
72 ### Make a user unfollow another user
76 - `follower`: The nickname of the follower
77 - `followed`: The nickname of the followed
81 ## `/api/pleroma/admin/users/:nickname/toggle_activation`
83 ### Toggle user activation
88 - Response: User’s object
98 ## `/api/pleroma/admin/users/tag`
100 ### Tag a list of users
107 ### Untag a list of users
114 ## `/api/pleroma/admin/permission_group/:nickname`
116 ### Get user user permission groups membership
124 "is_moderator": bool,
129 ## `/api/pleroma/admin/permission_group/:nickname/:permission_group`
131 Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
133 ### Get user user permission groups membership per permission group
141 "is_moderator": bool,
146 ### Add user in permission group
151 - On failure: `{"error": "…"}`
152 - On success: JSON of the `user.info`
154 ### Remove user from permission group
159 - On failure: `{"error": "…"}`
160 - On success: JSON of the `user.info`
161 - Note: An admin cannot revoke their own admin status.
163 ## `/api/pleroma/admin/activation_status/:nickname`
165 ### Active or deactivate a user
170 - `status` BOOLEAN field, false value means deactivation.
172 ## `/api/pleroma/admin/users/:nickname`
174 ### Retrive the details of a user
180 - On failure: `Not found`
181 - On success: JSON of the user
183 ## `/api/pleroma/admin/relay`
191 - On success: URL of the followed relay
199 - On success: URL of the unfollowed relay
201 ## `/api/pleroma/admin/invite_token`
203 ### Get an account registration invite token
207 - *optional* `invite` => [
208 - *optional* `max_use` (integer)
209 - *optional* `expires_at` (date string e.g. "2019-04-07")
211 - Response: invite token (base64 string)
213 ## `/api/pleroma/admin/invites`
215 ### Get a list of generated invites
232 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
239 ## `/api/pleroma/admin/revoke_invite`
241 ### Revoke invite by token
256 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
262 ## `/api/pleroma/admin/email_invite`
264 ### Sends registration invite via email
271 ## `/api/pleroma/admin/password_reset`
273 ### Get a password reset token for a given nickname
277 - Response: password reset token (base64 string)