diff options
| author | lain <lain@soykaf.club> | 2019-12-10 13:44:06 +0000 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2019-12-10 13:44:06 +0000 |
| commit | aac0187ec13078d2756db1671e644d6eb9c0947b (patch) | |
| tree | 1e0b4fa5d7ca5d12ac2d41ee5a077f669f64fb43 /docs/API | |
| parent | 54b1b2c9c0c24165b5b32c352fa684eed28bfa93 (diff) | |
| parent | 1ae976ac51d5ad7c224fa4d1ddee0bbd007d6787 (diff) | |
| download | pleroma-aac0187ec13078d2756db1671e644d6eb9c0947b.tar.gz | |
Merge branch '1427-oauth-admin-scopes' into 'develop'
[#1427] OAuth admin scopes
Closes #1427
See merge request pleroma/pleroma!2025
Diffstat (limited to 'docs/API')
| -rw-r--r-- | docs/API/admin_api.md | 7 |
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 |