aboutsummaryrefslogtreecommitdiff
path: root/docs/API/admin_api.md
diff options
context:
space:
mode:
authorMaxim Filippov <colixer@gmail.com>2019-12-12 02:16:23 +0300
committerMaxim Filippov <colixer@gmail.com>2019-12-12 02:16:23 +0300
commit3ecf131511afc1fc366be6402ca94cf0e6c30e11 (patch)
tree0e8a59c43ccc344bb7d57c32826675aa706b7e8e /docs/API/admin_api.md
parentcc36a8ea906bd22884101632c6d62c9572e846e1 (diff)
parentfd697cf2090b61db60a02694c3227850df176e2d (diff)
downloadpleroma-3ecf131511afc1fc366be6402ca94cf0e6c30e11.tar.gz
Merge branch 'develop' into feature/report-notes
Diffstat (limited to 'docs/API/admin_api.md')
-rw-r--r--docs/API/admin_api.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md
index 98efbf9c9..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