X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;ds=sidebyside;f=docs%2FAPI%2Fadmin_api.md;h=d98a78af025c10c31216eea87fb04a0501d0005b;hb=85f45c768994ce9e0642cc3fc29b68b1ec9a6684;hp=e51fad2cb01f41e62320d21ca837fea129284cef;hpb=4b60d41db9d10e971ee91202389991da294c72de;p=akkoma diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index e51fad2cb..d98a78af0 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -2,6 +2,13 @@ Authentication is required and the user must be an admin. +Configuration options: + +* `[:auth, :enforce_oauth_admin_scope_usage]` — OAuth admin scope requirement toggle. + If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token (client app must support admin scopes). + If `false` and token doesn't have admin scope(s), `is_admin` user flag grants access to admin-specific actions. + Note that client app needs to explicitly support admin scopes and request them when obtaining auth token. + ## `GET /api/pleroma/admin/users` ### List users @@ -609,16 +616,28 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ## `POST /api/pleroma/admin/reports/:id/notes` -### Create a report note +### Create report note - Params: - - `id` + - `id`: required, report id - `content`: required, the message - Response: - On failure: - 400 Bad Request `"Invalid parameters"` when `status` is missing - On success: `204`, empty response +## `POST /api/pleroma/admin/reports/:report_id/notes/:id` + +### Delete report note + +- Params: + - `report_id`: required, report id + - `id`: required, note id +- Response: + - On failure: + - 400 Bad Request `"Invalid parameters"` when `status` is missing + - On success: `204`, empty response + ## `PUT /api/pleroma/admin/statuses/:id` ### Change the scope of an individual reported status