mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-05 17:38:03 +08:00
Update the documentation pages
This commit is contained in:
OpenIddict Bot
parent
5a02224f34
commit
fe6da0de23
@ -218,11 +218,70 @@ store the tenant name. Once added, the URIs can include a placeholder of the sam
|
||||
Description="The tenant used to identify the Zendesk instance" />
|
||||
</Provider>
|
||||
</code></pre></div>
|
||||
<h2 id="unwrap-userinfo-responses-if-necessary">Unwrap userinfo responses if necessary</h2>
|
||||
<p>If the provider returns wrapped or nested userinfo responses (e.g under a <code>response</code> or <code>data</code> node), the <code>UnwrapUserinfoResponse</code> handler in
|
||||
<a href="https://github.com/openiddict/openiddict-core/blob/dev/src/OpenIddict.Client.WebIntegration/OpenIddictClientWebIntegrationHandlers.Userinfo.cs">OpenIddictClientWebIntegrationHandlers.Userinfo.cs</a>
|
||||
must be updated to unwrap the userinfo payload and allow OpenIddict to map them to flat CLR <code>Claim</code> instances:</p>
|
||||
<pre><code class="lang-csharp">/// <summary>
|
||||
/// Contains the logic responsible for extracting the userinfo response
|
||||
/// from nested JSON nodes (e.g "data") for the providers that require it.
|
||||
/// </summary>
|
||||
public sealed class UnwrapUserinfoResponse : IOpenIddictClientHandler<ExtractUserinfoResponseContext>
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the default descriptor definition assigned to this handler.
|
||||
/// </summary>
|
||||
public static OpenIddictClientHandlerDescriptor Descriptor { get; }
|
||||
= OpenIddictClientHandlerDescriptor.CreateBuilder<ExtractUserinfoResponseContext>()
|
||||
.UseSingletonHandler<UnwrapUserinfoResponse>()
|
||||
.SetOrder(int.MaxValue - 50_000)
|
||||
.SetType(OpenIddictClientHandlerType.BuiltIn)
|
||||
.Build();
|
||||
|
||||
/// <inheritdoc/>
|
||||
public ValueTask HandleAsync(ExtractUserinfoResponseContext context)
|
||||
{
|
||||
if (context is null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(context));
|
||||
}
|
||||
|
||||
context.Response = context.Registration.ProviderType switch
|
||||
{
|
||||
// Fitbit returns a nested "user" object.
|
||||
ProviderTypes.Fitbit => new(context.Response["user"]?.GetNamedParameters() ??
|
||||
throw new InvalidOperationException(SR.FormatID0334("user"))),
|
||||
|
||||
// StackExchange returns an "items" array containing a single element.
|
||||
ProviderTypes.StackExchange => new(context.Response["items"]?[0]?.GetNamedParameters() ??
|
||||
throw new InvalidOperationException(SR.FormatID0334("items/0"))),
|
||||
|
||||
// SubscribeStar returns a nested "user" object that is itself nested in a GraphQL "data" node.
|
||||
ProviderTypes.SubscribeStar => new(context.Response["data"]?["user"]?.GetNamedParameters() ??
|
||||
throw new InvalidOperationException(SR.FormatID0334("data/user"))),
|
||||
|
||||
_ => context.Response
|
||||
};
|
||||
|
||||
return default;
|
||||
}
|
||||
}
|
||||
</code></pre><div class="NOTE"><h5>Note</h5><p>If you're unsure whether the provider returns wrapped responses or not, the
|
||||
received payload can be found in the logs after a successful authorization flow:</p>
|
||||
<pre><code>OpenIddict.Client.OpenIddictClientDispatcher: Information: The userinfo response returned by https://contoso.com/users/me was successfully extracted: {
|
||||
"data": {
|
||||
"username": "odile.donat",
|
||||
"name": "Odile Donat",
|
||||
"email": "odile.donat@fabrikam.com"
|
||||
}
|
||||
}.
|
||||
</code></pre></div>
|
||||
<h2 id="if-the-provider-doesnt-support-standard-openid-connect-userinfo-map-the-provider-specific-claims-to-their-claimtypes-equivalent">If the provider doesn't support standard OpenID Connect userinfo, map the provider-specific claims to their <code>ClaimTypes</code> equivalent</h2>
|
||||
<p>If the provider doesn't return an <code>id_token</code> and doesn't offer a standard userinfo endpoint, it is likely it uses custom parameters
|
||||
to represent things like the user identifier. If so, update the <code>MapCustomWebServicesFederationClaims</code> event handler to map these
|
||||
parameters to the usual WS-Federation claims exposed by the .NET BCL <code>ClaimTypes</code> class, which simplifies integration with libraries
|
||||
like ASP.NET Core Identity:</p>
|
||||
to represent things like the user identifier. If so, update the <code>MapCustomWebServicesFederationClaims</code> event handler in
|
||||
<a href="https://github.com/openiddict/openiddict-core/blob/dev/src/OpenIddict.Client.WebIntegration/OpenIddictClientWebIntegrationHandlers.cs">OpenIddictClientWebIntegrationHandlers.cs</a>
|
||||
to map these parameters to the usual WS-Federation claims exposed by the .NET BCL <code>ClaimTypes</code> class, which simplifies integration
|
||||
with libraries like ASP.NET Core Identity:</p>
|
||||
<pre><code class="lang-csharp">/// <summary>
|
||||
/// Contains the logic responsible for mapping select custom claims to
|
||||
/// their WS-Federation equivalent for the providers that require it.
|
||||
|
||||
@ -264,7 +264,7 @@ To reference the OpenIddict MyGet feed, <strong>create a <code>NuGet.config</cod
|
||||
<p><strong>OpenIddict</strong> is actively maintained by <strong><a href="https://github.com/kevinchalet">Kévin Chalet</a></strong>. Contributions are welcome and can be submitted using pull requests.</p>
|
||||
<p><strong>Special thanks to <a href="https://github.com/sponsors/kevinchalet#sponsors">our sponsors</a> for their incredible support</strong>:</p>
|
||||
<p><a href="https://volosoft.com/"><img src="https://volosoft.com/assets/logos/volosoft-logo-dark.svg" width="500px" alt="Volosoft logo"></a></p>
|
||||
<p><!-- sponsors --><a href="https://github.com/sebastienros"><img src="https://github.com/sebastienros.png" width="60px" alt="Sébastien Ros"></a><a href="https://github.com/schmitch"><img src="https://github.com/schmitch.png" width="60px" alt="Schmitt Christian"></a><a href="https://github.com/cryo75"><img src="https://github.com/cryo75.png" width="60px" alt=""></a><a href="https://github.com/florianwachs"><img src="https://github.com/florianwachs.png" width="60px" alt="Florian Wachs"></a><a href="https://github.com/SebastianStehle"><img src="https://github.com/SebastianStehle.png" width="60px" alt="Sebastian Stehle"></a><a href="https://github.com/communicatie-cockpit"><img src="https://github.com/communicatie-cockpit.png" width="60px" alt="Communicatie Cockpit"></a><a href="https://github.com/KeithT"><img src="https://github.com/KeithT.png" width="60px" alt=""></a><a href="https://github.com/Skrypt"><img src="https://github.com/Skrypt.png" width="60px" alt="Jasmin Savard"></a><a href="https://github.com/ThomasBjallas"><img src="https://github.com/ThomasBjallas.png" width="60px" alt="Thomas"></a><a href="https://github.com/mcalasa"><img src="https://github.com/mcalasa.png" width="60px" alt="MCee"></a><a href="https://github.com/feededit"><img src="https://github.com/feededit.png" width="60px" alt=""></a><a href="https://github.com/DigitalOpsDev"><img src="https://github.com/DigitalOpsDev.png" width="60px" alt="DigitalOps Co. Ltd."></a><a href="https://github.com/jacojvv-dev"><img src="https://github.com/jacojvv-dev.png" width="60px" alt="Jaco Jansen van Vuuren"></a><a href="https://github.com/EYERIDE-Fleet-Management-System"><img src="https://github.com/EYERIDE-Fleet-Management-System.png" width="60px" alt="EYERIDE Fleet Management System"></a><a href="https://github.com/salimz1"><img src="https://github.com/salimz1.png" width="60px" alt=""></a><a href="https://github.com/hypdeb"><img src="https://github.com/hypdeb.png" width="60px" alt="Julien Debache"></a><a href="https://github.com/StanlyLife"><img src="https://github.com/StanlyLife.png" width="60px" alt="Stian Håve"></a><a href="https://github.com/ravindUwU"><img src="https://github.com/ravindUwU.png" width="60px" alt="Ravindu Liyanapathirana"></a><a href="https://github.com/dlandi"><img src="https://github.com/dlandi.png" width="60px" alt="HieronymusBlaze"></a><a href="https://github.com/ahanoff"><img src="https://github.com/ahanoff.png" width="60px" alt="Akhan Zhakiyanov"></a><a href="https://github.com/CorentinBrossutti1"><img src="https://github.com/CorentinBrossutti1.png" width="60px" alt="Corentin BROSSUTTI"></a><a href="https://github.com/blowdart"><img src="https://github.com/blowdart.png" width="60px" alt="Barry Dorrans"></a><a href="https://github.com/devqsrl"><img src="https://github.com/devqsrl.png" width="60px" alt="DevQ S.r.l."></a><a href="https://github.com/dgxhubbard"><img src="https://github.com/dgxhubbard.png" width="60px" alt=""></a><a href="https://github.com/verdie-g"><img src="https://github.com/verdie-g.png" width="60px" alt="Grégoire"></a><a href="https://github.com/xperiandri"><img src="https://github.com/xperiandri.png" width="60px" alt="Andrii Chebukin"></a><a href="https://github.com/neil-timmerman"><img src="https://github.com/neil-timmerman.png" width="60px" alt=""></a><a href="https://github.com/forterro"><img src="https://github.com/forterro.png" width="60px" alt="Forterro"></a><a href="https://github.com/MarcelMalik"><img src="https://github.com/MarcelMalik.png" width="60px" alt="Marcel"></a><a href="https://github.com/expeo"><img src="https://github.com/expeo.png" width="60px" alt=""></a><!-- sponsors --></p>
|
||||
<p><!-- sponsors --><a href="https://github.com/sebastienros"><img src="https://github.com/sebastienros.png" width="60px" alt="Sébastien Ros"></a><a href="https://github.com/schmitch"><img src="https://github.com/schmitch.png" width="60px" alt="Schmitt Christian"></a><a href="https://github.com/cryo75"><img src="https://github.com/cryo75.png" width="60px" alt=""></a><a href="https://github.com/florianwachs"><img src="https://github.com/florianwachs.png" width="60px" alt="Florian Wachs"></a><a href="https://github.com/SebastianStehle"><img src="https://github.com/SebastianStehle.png" width="60px" alt="Sebastian Stehle"></a><a href="https://github.com/communicatie-cockpit"><img src="https://github.com/communicatie-cockpit.png" width="60px" alt="Communicatie Cockpit"></a><a href="https://github.com/KeithT"><img src="https://github.com/KeithT.png" width="60px" alt=""></a><a href="https://github.com/Skrypt"><img src="https://github.com/Skrypt.png" width="60px" alt="Jasmin Savard"></a><a href="https://github.com/ThomasBjallas"><img src="https://github.com/ThomasBjallas.png" width="60px" alt="Thomas"></a><a href="https://github.com/mcalasa"><img src="https://github.com/mcalasa.png" width="60px" alt="MCee"></a><a href="https://github.com/feededit"><img src="https://github.com/feededit.png" width="60px" alt=""></a><a href="https://github.com/DigitalOpsDev"><img src="https://github.com/DigitalOpsDev.png" width="60px" alt="DigitalOps Co. Ltd."></a><a href="https://github.com/jacojvv-dev"><img src="https://github.com/jacojvv-dev.png" width="60px" alt="Jaco Jansen van Vuuren"></a><a href="https://github.com/EYERIDE-Fleet-Management-System"><img src="https://github.com/EYERIDE-Fleet-Management-System.png" width="60px" alt="EYERIDE Fleet Management System"></a><a href="https://github.com/salimz1"><img src="https://github.com/salimz1.png" width="60px" alt=""></a><a href="https://github.com/hypdeb"><img src="https://github.com/hypdeb.png" width="60px" alt="Julien Debache"></a><a href="https://github.com/StanlyLife"><img src="https://github.com/StanlyLife.png" width="60px" alt="Stian Håve"></a><a href="https://github.com/ravindUwU"><img src="https://github.com/ravindUwU.png" width="60px" alt="Ravindu Liyanapathirana"></a><a href="https://github.com/dlandi"><img src="https://github.com/dlandi.png" width="60px" alt="HieronymusBlaze"></a><a href="https://github.com/ahanoff"><img src="https://github.com/ahanoff.png" width="60px" alt="Akhan Zhakiyanov"></a><a href="https://github.com/CorentinBrossutti1"><img src="https://github.com/CorentinBrossutti1.png" width="60px" alt="Corentin BROSSUTTI"></a><a href="https://github.com/blowdart"><img src="https://github.com/blowdart.png" width="60px" alt="Barry Dorrans"></a><a href="https://github.com/devqsrl"><img src="https://github.com/devqsrl.png" width="60px" alt="DevQ S.r.l."></a><a href="https://github.com/dgxhubbard"><img src="https://github.com/dgxhubbard.png" width="60px" alt=""></a><a href="https://github.com/verdie-g"><img src="https://github.com/verdie-g.png" width="60px" alt="Grégoire"></a><a href="https://github.com/xperiandri"><img src="https://github.com/xperiandri.png" width="60px" alt="Andrii Chebukin"></a><a href="https://github.com/neil-timmerman"><img src="https://github.com/neil-timmerman.png" width="60px" alt=""></a><a href="https://github.com/forterro"><img src="https://github.com/forterro.png" width="60px" alt="Forterro"></a><a href="https://github.com/MarcelMalik"><img src="https://github.com/MarcelMalik.png" width="60px" alt="Marcel"></a><a href="https://github.com/expeo"><img src="https://github.com/expeo.png" width="60px" alt=""></a><a href="https://github.com/jwillmer"><img src="https://github.com/jwillmer.png" width="60px" alt="Jens Willmer"></a><a href="https://github.com/craaash80"><img src="https://github.com/craaash80.png" width="60px" alt=""></a><!-- sponsors --></p>
|
||||
<hr>
|
||||
<h2 id="license">License</h2>
|
||||
<p>This project is licensed under the <strong>Apache License</strong>. This means that you can use, modify and distribute it freely.
|
||||
|
||||
@ -1600,7 +1600,7 @@
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "guides/contributing-a-new-web-provider.html",
|
||||
"hash": "TVxxQxHBmAEQiyh1LF4KZQ=="
|
||||
"hash": "zn6aU7/pypsyz6PAQMbGbw=="
|
||||
}
|
||||
},
|
||||
"is_incremental": false,
|
||||
@ -1694,7 +1694,7 @@
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "index.html",
|
||||
"hash": "aSgtFSzx/YtktQZx5WGJDg=="
|
||||
"hash": "JrsiUi4UaF8z/3YY6GZfcQ=="
|
||||
}
|
||||
},
|
||||
"is_incremental": false,
|
||||
|
||||
Loading…
Reference in New Issue
Block a user