diff options
author | feld <feld@feld.me> | 2021-02-03 14:23:23 +0000 |
---|---|---|
committer | feld <feld@feld.me> | 2021-02-03 14:23:23 +0000 |
commit | 008499f65a33f5d42a98cc3719f6ab5e8def40d6 (patch) | |
tree | 1bcf258f38105267d4f655d8aed68d1ab502523f /docs/configuration/cheatsheet.md | |
parent | 39335d42513e47289fc825d04680531b84862686 (diff) | |
parent | c3dd860a027ef1339285b5b62dc62e0b48bc6855 (diff) | |
download | pleroma-008499f65a33f5d42a98cc3719f6ab5e8def40d6.tar.gz pleroma-008499f65a33f5d42a98cc3719f6ab5e8def40d6.zip |
Merge branch 'develop' into 'fix/2412-filters'
# Conflicts:
# CHANGELOG.md
Diffstat (limited to 'docs/configuration/cheatsheet.md')
-rw-r--r-- | docs/configuration/cheatsheet.md | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md index 9d4b07bf4..ad5768465 100644 --- a/docs/configuration/cheatsheet.md +++ b/docs/configuration/cheatsheet.md @@ -893,6 +893,22 @@ Pleroma account will be created with the same name as the LDAP user name. Note, if your LDAP server is an Active Directory server the correct value is commonly `uid: "cn"`, but if you use an OpenLDAP server the value may be `uid: "uid"`. +### :oauth2 (Pleroma as OAuth 2.0 provider settings) + +OAuth 2.0 provider settings: + +* `token_expires_in` - The lifetime in seconds of the access token. +* `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token. +* `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`. + +OAuth 2.0 provider and related endpoints: + +* `POST /api/v1/apps` creates client app basing on provided params. +* `GET/POST /oauth/authorize` renders/submits authorization form. +* `POST /oauth/token` creates/renews OAuth token. +* `POST /oauth/revoke` revokes provided OAuth token. +* `GET /api/v1/accounts/verify_credentials` (with proper `Authorization` header or `access_token` URI param) returns user info on requester (with `acct` field containing local nickname and `fqn` field containing fully-qualified nickname which could generally be used as email stub for OAuth software that demands email field in identity endpoint response, like Peertube). + ### OAuth consumer mode OAuth consumer mode allows sign in / sign up via external OAuth providers (e.g. Twitter, Facebook, Google, Microsoft, etc.). @@ -965,14 +981,6 @@ config :ueberauth, Ueberauth, ] ``` -### OAuth 2.0 provider - :oauth2 - -Configure OAuth 2 provider capabilities: - -* `token_expires_in` - The lifetime in seconds of the access token. -* `issue_new_refresh_token` - Keeps old refresh token or generate new refresh token when to obtain an access token. -* `clean_expired_tokens` - Enable a background job to clean expired oauth tokens. Defaults to `false`. - ## Link parsing ### :uri_schemes |