aboutsummaryrefslogtreecommitdiff
path: root/docs/API/admin_api.md
diff options
context:
space:
mode:
authorMaxim Filippov <colixer@gmail.com>2019-11-05 02:12:48 +0300
committerMaxim Filippov <colixer@gmail.com>2019-11-05 02:12:48 +0300
commit43ea16870fe60578a6528e1f01bfaab68943a1bc (patch)
tree108e2d85abfa60cea3b85cd07e0b2ab467b39668 /docs/API/admin_api.md
parent24eecc3cb4a35376124b1fc792183d8b8dd0a9cc (diff)
parentfee127696308dbec9cff6b2a9b399cf2877cf445 (diff)
downloadpleroma-43ea16870fe60578a6528e1f01bfaab68943a1bc.tar.gz
Merge branch 'develop' into feature/reports-groups-and-multiple-state-update
Diffstat (limited to 'docs/API/admin_api.md')
-rw-r--r--docs/API/admin_api.md88
1 files changed, 82 insertions, 6 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md
index e8232225c..9499d0140 100644
--- a/docs/API/admin_api.md
+++ b/docs/API/admin_api.md
@@ -46,7 +46,7 @@ Authentication is required and the user must be an admin.
}
```
-## `DELETE /api/pleroma/admin/users`
+## DEPRECATED `DELETE /api/pleroma/admin/users`
### Remove a user
@@ -54,6 +54,15 @@ Authentication is required and the user must be an admin.
- `nickname`
- Response: User’s nickname
+## `DELETE /api/pleroma/admin/users`
+
+### Remove a user
+
+- Method `DELETE`
+- Params:
+ - `nicknames`
+- Response: Array of user nicknames
+
### Create a user
- Method: `POST`
@@ -149,14 +158,26 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
}
```
-## `POST /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
+## DEPRECATED `POST /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
-### Add user in permission group
+### Add user to permission group
- Params: none
- Response:
- On failure: `{"error": "…"}`
- - On success: JSON of the `user.info`
+ - On success: JSON of the user
+
+## `POST /api/pleroma/admin/users/permission_group/:permission_group`
+
+### Add users to permission group
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+ - On failure: `{"error": "…"}`
+ - On success: JSON of the user
+
+## DEPRECATED `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
## `DELETE /api/pleroma/admin/users/:nickname/permission_group/:permission_group`
@@ -165,10 +186,57 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
- Params: none
- Response:
- On failure: `{"error": "…"}`
- - On success: JSON of the `user.info`
+ - On success: JSON of the user
+- Note: An admin cannot revoke their own admin status.
+
+## `DELETE /api/pleroma/admin/users/permission_group/:permission_group`
+
+### Remove users from permission group
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+ - On failure: `{"error": "…"}`
+ - On success: JSON of the user
- Note: An admin cannot revoke their own admin status.
-## `PUT /api/pleroma/admin/users/:nickname/activation_status`
+## `PATCH /api/pleroma/admin/users/activate`
+
+### Activate user
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+ users: [
+ {
+ // user object
+ }
+ ]
+}
+```
+
+## `PATCH /api/pleroma/admin/users/deactivate`
+
+### Deactivate user
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+ users: [
+ {
+ // user object
+ }
+ ]
+}
+```
+
+## DEPRECATED `PATCH /api/pleroma/admin/users/:nickname/activation_status`
### Active or deactivate a user
@@ -216,6 +284,14 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
- Response:
- On success: URL of the unfollowed relay
+## `GET /api/pleroma/admin/relay`
+
+### List Relays
+
+- Params: none
+- Response:
+ - On success: JSON array of relays
+
## `POST /api/pleroma/admin/users/invite_token`
### Create an account registration invite token