3 Authentication is required and the user must be an admin.
5 ## `/api/pleroma/admin/users`
11 - *optional* `query`: **string** search term (e.g. nickname, domain, nickname@domain)
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 - `is_admin`: users with admin role
18 - `is_moderator`: users with moderator role
19 - *optional* `page`: **integer** page number
20 - *optional* `page_size`: **integer** number of users per page (default is `50`)
21 - *optional* `tags`: **[string]** tags list
22 - *optional* `name`: **string** user display name
23 - *optional* `email`: **string** user email
24 - 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`
48 ## `/api/pleroma/admin/users`
55 - Response: User’s nickname
64 - Response: User’s nickname
66 ## `/api/pleroma/admin/users/follow`
67 ### Make a user follow another user
71 - `follower`: The nickname of the follower
72 - `followed`: The nickname of the followed
76 ## `/api/pleroma/admin/users/unfollow`
77 ### Make a user unfollow another user
81 - `follower`: The nickname of the follower
82 - `followed`: The nickname of the followed
86 ## `/api/pleroma/admin/users/:nickname/toggle_activation`
88 ### Toggle user activation
93 - Response: User’s object
103 ## `/api/pleroma/admin/users/tag`
105 ### Tag a list of users
109 - `nicknames` (array)
112 ### Untag a list of users
116 - `nicknames` (array)
119 ## `/api/pleroma/admin/users/:nickname/permission_group`
121 ### Get user user permission groups membership
129 "is_moderator": bool,
134 ## `/api/pleroma/admin/users/:nickname/permission_group/:permission_group`
136 Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
138 ### Get user user permission groups membership per permission group
146 "is_moderator": bool,
151 ### Add user in permission group
156 - On failure: `{"error": "…"}`
157 - On success: JSON of the `user.info`
159 ### Remove user from permission group
164 - On failure: `{"error": "…"}`
165 - On success: JSON of the `user.info`
166 - Note: An admin cannot revoke their own admin status.
168 ## `/api/pleroma/admin/users/:nickname/activation_status`
170 ### Active or deactivate a user
175 - `status` BOOLEAN field, false value means deactivation.
177 ## `/api/pleroma/admin/users/:nickname`
179 ### Retrive the details of a user
185 - On failure: `Not found`
186 - On success: JSON of the user
188 ## `/api/pleroma/admin/relay`
196 - On success: URL of the followed relay
204 - On success: URL of the unfollowed relay
206 ## `/api/pleroma/admin/users/invite_token`
208 ### Get an account registration invite token
212 - *optional* `invite` => [
213 - *optional* `max_use` (integer)
214 - *optional* `expires_at` (date string e.g. "2019-04-07")
216 - Response: invite token (base64 string)
218 ## `/api/pleroma/admin/users/invites`
220 ### Get a list of generated invites
237 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
244 ## `/api/pleroma/admin/users/revoke_invite`
246 ### Revoke invite by token
261 "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
267 ## `/api/pleroma/admin/users/email_invite`
269 ### Sends registration invite via email
276 ## `/api/pleroma/admin/users/:nickname/password_reset`
278 ### Get a password reset token for a given nickname
282 - Response: password reset token (base64 string)