Page MenuHomePhorge
Files F85828470

No OneTemporary
Actions

Authored By
Unknown
Size
4 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/docs/Admin-API.md b/docs/Admin-API.md
index 4403620bf..407647645 100644
--- a/docs/Admin-API.md
+++ b/docs/Admin-API.md
@@ -1,194 +1,207 @@
# Admin API
Authentication is required and the user must be an admin.
## `/api/pleroma/admin/users`
### List users
- Method `GET`
+- Params:
+ - `page`: **integer** page number
+ - `page_size`: **integer** number of users per page (default is `50`)
- Response:
```JSON
-[
+{
+ "page_size": integer,
+ "count": integer,
+ "users": [
{
- "deactivated": bool,
- "id": integer,
- "nickname": string
+ "deactivated": bool,
+ "id": integer,
+ "nickname": string
},
...
-]
+ ]
+}
```
-## `/api/pleroma/admin/users/search?query={query}&local={local}`
+## `/api/pleroma/admin/users/search?query={query}&local={local}&page={page}&page_size={page_size}`
### Search users by name or nickname
- Method `GET`
- Params:
- `query`: **string** search term
- `local`: **bool** whether to return only local users
+ - `page`: **integer** page number
+ - `page_size`: **integer** number of users per page (default is `50`)
- Response:
```JSON
-[
+{
+ "page_size": integer,
+ "count": integer,
+ "users": [
{
- "deactivated": bool,
- "id": integer,
- "nickname": string
+ "deactivated": bool,
+ "id": integer,
+ "nickname": string
},
...
-]
+ ]
+}
```
## `/api/pleroma/admin/user`
### Remove a user
- Method `DELETE`
- Params:
- `nickname`
- Response: User’s nickname
### Create a user
- Method: `POST`
- Params:
- `nickname`
- `email`
- `password`
- Response: User’s nickname
## `/api/pleroma/admin/users/:nickname/toggle_activation`
### Toggle user activation
- Method: `PATCH`
- Params:
- `nickname`
- Response: User’s object
```JSON
{
- "deactivated": bool,
- "id": integer,
- "nickname": string
+ "deactivated": bool,
+ "id": integer,
+ "nickname": string
}
```
## `/api/pleroma/admin/users/tag`
### Tag a list of users
- Method: `PUT`
- Params:
- `nickname`
- `tags`
### Untag a list of users
- Method: `DELETE`
- Params:
- `nickname`
- `tags`
## `/api/pleroma/admin/permission_group/:nickname`
### Get user user permission groups membership
- Method: `GET`
- Params: none
- Response:
```JSON
{
- "is_moderator": bool,
- "is_admin": bool
+ "is_moderator": bool,
+ "is_admin": bool
}
```
## `/api/pleroma/admin/permission_group/:nickname/:permission_group`
Note: Available `:permission_group` is currently moderator and admin. 404 is returned when the permission group doesn’t exist.
### Get user user permission groups membership
- Method: `GET`
- Params: none
- Response:
```JSON
{
- "is_moderator": bool,
- "is_admin": bool
+ "is_moderator": bool,
+ "is_admin": bool
}
```
### Add user in permission group
- Method: `POST`
- Params: none
- Response:
- On failure: `{"error": "…"}`
- On success: JSON of the `user.info`
### Remove user from permission group
- Method: `DELETE`
- Params: none
- Response:
- On failure: `{"error": "…"}`
- On success: JSON of the `user.info`
- Note: An admin cannot revoke their own admin status.
## `/api/pleroma/admin/activation_status/:nickname`
### Active or deactivate a user
- Method: `PUT`
- Params:
- `nickname`
- `status` BOOLEAN field, false value means deactivation.
## `/api/pleroma/admin/relay`
### Follow a Relay
- Methods: `POST`
- Params:
- `relay_url`
- Response:
- On success: URL of the followed relay
### Unfollow a Relay
- Methods: `DELETE`
- Params:
- `relay_url`
- Response:
- On success: URL of the unfollowed relay
## `/api/pleroma/admin/invite_token`
### Get a account registeration invite token
- Methods: `GET`
- Params: none
- Response: invite token (base64 string)
## `/api/pleroma/admin/email_invite`
### Sends registration invite via email
- Methods: `POST`
- Params:
- `email`
- `name`, optionnal
## `/api/pleroma/admin/password_reset`
### Get a password reset token for a given nickname
- Methods: `GET`
- Params: none
- Response: password reset token (base64 string)

File Metadata

Mime Type
text/x-diff
Expires
Sat, Oct 31, 7:20 AM (18 h, 12 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1801150
Default Alt Text
(4 KB)

Event Timeline