aboutsummaryrefslogtreecommitdiff
path: root/docs/api/admin_api.md
diff options
context:
space:
mode:
authorMaxim Filippov <colixer@gmail.com>2019-09-26 19:01:54 +0300
committerMaxim Filippov <colixer@gmail.com>2019-09-26 19:01:54 +0300
commite7836adf21421de7a6d1d84fd605ec7d7f207cda (patch)
treeca378665486e37ec82a19feb95c84d2131b83e7a /docs/api/admin_api.md
parentdf15ed13d15db5b5a371345fcb9968b5af4100af (diff)
parent6abe12dceda8d0d32878208987a9631d5d546a3d (diff)
downloadpleroma-e7836adf21421de7a6d1d84fd605ec7d7f207cda.tar.gz
Merge branch 'develop' into feature/moderation-log-filters
Diffstat (limited to 'docs/api/admin_api.md')
-rw-r--r--docs/api/admin_api.md50
1 files changed, 42 insertions, 8 deletions
diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md
index fd608c459..d4e08f221 100644
--- a/docs/api/admin_api.md
+++ b/docs/api/admin_api.md
@@ -224,15 +224,25 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
## `/api/pleroma/admin/users/invite_token`
-### Get an account registration invite token
+### Create an account registration invite token
-- Methods: `GET`
+- Methods: `POST`
- Params:
- - *optional* `invite` => [
- - *optional* `max_use` (integer)
- - *optional* `expires_at` (date string e.g. "2019-04-07")
- ]
-- Response: invite token (base64 string)
+ - *optional* `max_use` (integer)
+ - *optional* `expires_at` (date string e.g. "2019-04-07")
+- Response:
+
+```json
+{
+ "id": integer,
+ "token": string,
+ "used": boolean,
+ "expires_at": date,
+ "uses": integer,
+ "max_use": integer,
+ "invite_type": string (possible values: `one_time`, `reusable`, `date_limited`, `reusable_date_limited`)
+}
+```
## `/api/pleroma/admin/users/invites`
@@ -298,7 +308,23 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
- Methods: `GET`
- Params: none
-- Response: password reset token (base64 string)
+- Response:
+
+```json
+{
+ "token": "U13DX6muOvpRsj35_ij9wLxUbkU-eFvfKttxs6gIajo=", // password reset token (base64 string)
+ "link": "https://pleroma.social/api/pleroma/password_reset/U13DX6muOvpRsj35_ij9wLxUbkU-eFvfKttxs6gIajo%3D"
+}
+```
+
+
+## `/api/pleroma/admin/users/:nickname/force_password_reset`
+
+### Force passord reset for a user with a given nickname
+
+- Methods: `PATCH`
+- Params: none
+- Response: none (code `204`)
## `/api/pleroma/admin/reports`
### Get a list of reports
@@ -317,6 +343,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
```json
{
+ "total" : 1,
"reports": [
{
"account": {
@@ -722,3 +749,10 @@ Compile time settings (need instance reboot):
}
]
```
+
+## `POST /api/pleroma/admin/reload_emoji`
+### Reload the instance's custom emoji
+* Method `POST`
+* Authentication: required
+* Params: None
+* Response: JSON, "ok" and 200 status