diff options
| author | Mark Felder <feld@FreeBSD.org> | 2019-12-11 15:02:53 -0600 |
|---|---|---|
| committer | Mark Felder <feld@FreeBSD.org> | 2019-12-11 15:02:53 -0600 |
| commit | 9ef912aecfbeef670db0614ec2014321c37f3b7a (patch) | |
| tree | 69eb0b5e11ca321e1ba8ca794171bf0cb425d16d /docs/API/admin_api.md | |
| parent | e21afdb7c76c9773aeb51e37ff3bc2874e7a74f7 (diff) | |
| parent | 92b4a1aa1bc750bb077ae45c422967f9712e247d (diff) | |
| download | pleroma-9ef912aecfbeef670db0614ec2014321c37f3b7a.tar.gz | |
Merge branch 'develop' into issue/1411
Diffstat (limited to 'docs/API/admin_api.md')
| -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 |