aboutsummaryrefslogtreecommitdiff
path: root/docs/API/admin_api.md
diff options
context:
space:
mode:
authorSadposter <hannah+pleroma@coffee-and-dreams.uk>2019-12-10 16:54:25 +0000
committerSadposter <hannah+pleroma@coffee-and-dreams.uk>2019-12-10 16:54:25 +0000
commit8cfaab8f04cae6fcc20a37cdb463ee0c93b71217 (patch)
tree5ea3e43a73796f264508b583051f6f2143071f00 /docs/API/admin_api.md
parent5abee19b63aa1577f8895b48ae69f0a51edb4dc3 (diff)
parentaac0187ec13078d2756db1671e644d6eb9c0947b (diff)
downloadpleroma-8cfaab8f04cae6fcc20a37cdb463ee0c93b71217.tar.gz
Merge branch 'develop' into 'domain-block-precedence'
# Conflicts: # lib/pleroma/user.ex
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 2cac317de..b19793150 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