lsm/openiddict-documentation
1
0
Fork 0
mirror of https://gitee.com/dcren/openiddict-documentation.git synced 2025-04-05 17:38:03 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update the web providers contribution guide to indicate how grant types are listed

Browse Source
This commit is contained in:
Kévin Chalet 2022-11-27 07:45:36 +01:00
parent 688eaa7fba
commit 4988a66ea4
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
guides/contributing-a-new-web-provider.md
View File

@ -89,11 +89,29 @@ the OpenIddict client to communicate with the remote authorization server. For i
<Environment Issuer="https://www.reddit.com/">
<Configuration AuthorizationEndpoint="https://www.reddit.com/api/v1/authorize"
TokenEndpoint="https://www.reddit.com/api/v1/access_token"
UserinfoEndpoint="https://oauth.reddit.com/api/v1/me" />
UserinfoEndpoint="https://oauth.reddit.com/api/v1/me">
<GrantType Value="authorization_code" />
<GrantType Value="refresh_token" />
</Configuration>
</Environment>
</Provider>
```
> [!NOTE]
> If the provider doesn't support `grant_type=refresh_token` and only supports the authorization code flow
> (typically with non-expiring access tokens), the `<GrantType>` nodes MUST be removed for clarity,
> as the authorization code flow is always considered supported by default if no `<GrantType>` is present:
>
> ```xml
> <Provider Name="Reddit">
> <Environment Issuer="https://www.reddit.com/">
> <Configuration AuthorizationEndpoint="https://www.reddit.com/api/v1/authorize"
> TokenEndpoint="https://www.reddit.com/api/v1/access_token"
> UserinfoEndpoint="https://oauth.reddit.com/api/v1/me" />
> </Environment>
> </Provider>
> ```
> [!CAUTION]
> If the provider doesn't support server metadata but is known to support Proof Key for Code Exchange (PKCE), a `<CodeChallengeMethod>` node MUST
> be added under `<Configuration>` to ensure the OpenIddict client will send appropriate `code_challenge`/`code_challenge_method` parameters: