-
Notifications
You must be signed in to change notification settings - Fork 253
Expand file tree
/
Copy pathMicrosoft.Identity.Web.xml
More file actions
2270 lines (2261 loc) · 151 KB
/
Microsoft.Identity.Web.xml
File metadata and controls
2270 lines (2261 loc) · 151 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Identity.Web</name>
</assembly>
<members>
<member name="T:Microsoft.Identity.Web.AccountExtensions">
<summary>
Extension methods for <see cref="T:Microsoft.Identity.Client.IAccount"/>.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.AccountExtensions.ToClaimsPrincipal(Microsoft.Identity.Client.IAccount)">
<summary>
Creates the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> from the values found
in an <see cref="T:Microsoft.Identity.Client.IAccount"/>.
</summary>
<param name="account">The <see cref="T:Microsoft.Identity.Client.IAccount"/> instance.</param>
<returns>A <see cref="T:System.Security.Claims.ClaimsPrincipal"/> built from <see cref="T:Microsoft.Identity.Client.IAccount"/>.</returns>
</member>
<member name="T:Microsoft.Identity.Web.AppServicesAuthenticationBuilderExtensions">
<summary>
Extension methods related to App Services authentication (Easy Auth).
</summary>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationBuilderExtensions.AddAppServicesAuthentication(Microsoft.AspNetCore.Authentication.AuthenticationBuilder)">
<summary>
Add authentication with App Services.
</summary>
<param name="builder">Authentication builder.</param>
<returns>The builder, to chain commands.</returns>
</member>
<member name="T:Microsoft.Identity.Web.AppServicesAuthenticationDefaults">
<summary>
Default values related to AppServiceAuthentication handler.
</summary>
</member>
<member name="F:Microsoft.Identity.Web.AppServicesAuthenticationDefaults.AuthenticationScheme">
<summary>
The default value used for AppServiceAuthenticationOptions.AuthenticationScheme.
</summary>
</member>
<member name="T:Microsoft.Identity.Web.AppServicesAuthenticationHandler">
<summary>
App service authentication handler.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationHandler.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Identity.Web.AppServicesAuthenticationOptions},Microsoft.Extensions.Logging.ILoggerFactory,System.Text.Encodings.Web.UrlEncoder,Microsoft.AspNetCore.Authentication.ISystemClock)">
<summary>
Constructor for the AppServiceAuthenticationHandler.
Note the parameters are required by the base class.
</summary>
<param name="options">App service authentication options.</param>
<param name="logger">Logger factory.</param>
<param name="encoder">URL encoder.</param>
<param name="clock">System clock.</param>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationHandler.HandleAuthenticateAsync">
<inheritdoc/>
</member>
<member name="T:Microsoft.Identity.Web.AppServicesAuthenticationInformation">
<summary>
Information about the App Services configuration on the host.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.AppServicesAuthenticationInformation.IsAppServicesAadAuthenticationEnabled">
<summary>
Is App Services authentication enabled?.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.AppServicesAuthenticationInformation.LogoutUrl">
<summary>
Logout URL for App Services Auth web sites.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.AppServicesAuthenticationInformation.ClientId">
<summary>
ClientID of the App Services Auth web site.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.AppServicesAuthenticationInformation.ClientSecret">
<summary>
Client secret of the App Services Auth web site.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.AppServicesAuthenticationInformation.Issuer">
<summary>
Issuer of the App Services Auth web site.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationInformation.SimulateGettingHeaderFromDebugEnvironmentVariable(System.String)">
<summary>
Get headers from environment to help debugging App Services authentication.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationInformation.GetIdToken(System.Collections.Generic.IDictionary{System.String,Microsoft.Extensions.Primitives.StringValues})">
<summary>
Get the ID token from the headers sent by App services authentication.
</summary>
<param name="headers">Headers.</param>
<returns>The ID Token.</returns>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationInformation.GetIdp(System.Collections.Generic.IDictionary{System.String,Microsoft.Extensions.Primitives.StringValues})">
<summary>
Get the IDP from the headers sent by App services authentication.
</summary>
<param name="headers">Headers.</param>
<returns>The IDP.</returns>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationInformation.GetUser(System.Collections.Generic.IDictionary{System.String,Microsoft.Extensions.Primitives.StringValues})">
<summary>
Get the user claims from the headers and environment variables.
</summary>
<param name="headers">Headers.</param>
<returns>User claims.</returns>
</member>
<member name="T:Microsoft.Identity.Web.AppServicesAuthenticationOptions">
<summary>
Options for Azure App Services authentication.
</summary>
</member>
<member name="T:Microsoft.Identity.Web.AppServicesAuthenticationTokenAcquisition">
<summary>
Implementation of ITokenAcquisition for App Services authentication (EasyAuth).
</summary>
</member>
<member name="F:Microsoft.Identity.Web.AppServicesAuthenticationTokenAcquisition._application">
<summary>
Please call GetOrCreateApplication instead of accessing this field directly.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationTokenAcquisition.#ctor(Microsoft.Identity.Web.TokenCacheProviders.IMsalTokenCacheProvider,Microsoft.AspNetCore.Http.IHttpContextAccessor,System.Net.Http.IHttpClientFactory)">
<summary>
Constructor of the AppServicesAuthenticationTokenAcquisition.
</summary>
<param name="tokenCacheProvider">The App token cache provider.</param>
<param name="httpContextAccessor">Access to the HttpContext of the request.</param>
<param name="httpClientFactory">HTTP client factory.</param>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationTokenAcquisition.GetAccessTokenForAppAsync(System.String,System.String,System.String,Microsoft.Identity.Web.TokenAcquisitionOptions)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationTokenAcquisition.GetAccessTokenForUserAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.Identity.Web.TokenAcquisitionOptions)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationTokenAcquisition.GetAuthenticationResultForUserAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.Identity.Web.TokenAcquisitionOptions)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationTokenAcquisition.ReplyForbiddenWithWwwAuthenticateHeaderAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.MsalUiRequiredException,Microsoft.AspNetCore.Http.HttpResponse)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationTokenAcquisition.ReplyForbiddenWithWwwAuthenticateHeader(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.MsalUiRequiredException,System.String,Microsoft.AspNetCore.Http.HttpResponse)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationTokenAcquisition.GetAuthenticationResultForAppAsync(System.String,System.String,System.String,Microsoft.Identity.Web.TokenAcquisitionOptions)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.AppServicesAuthenticationTokenAcquisition.GetEffectiveAuthenticationScheme(System.String)">
<inheritdoc/>
</member>
<member name="T:Microsoft.Identity.Web.AuthorizeForScopesAttribute">
<summary>
Filter used on a controller action to trigger incremental consent.
</summary>
<example>
The following controller action will trigger.
<code>
[AuthorizeForScopes(Scopes = new[] {"Mail.Send"})]
public async Task<IActionResult> SendEmail()
{
}
</code>
</example>
</member>
<member name="P:Microsoft.Identity.Web.AuthorizeForScopesAttribute.Scopes">
<summary>
Scopes to request.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.AuthorizeForScopesAttribute.ScopeKeySection">
<summary>
Key section on the configuration file that holds the scope value.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.AuthorizeForScopesAttribute.UserFlow">
<summary>
Azure AD B2C user flow.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.AuthorizeForScopesAttribute.AuthenticationScheme">
<summary>
Allows specifying an AuthenticationScheme if OpenIdConnect is not the default challenge scheme.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.AuthorizeForScopesAttribute.OnException(Microsoft.AspNetCore.Mvc.Filters.ExceptionContext)">
<summary>
Handles the <see cref="T:Microsoft.Identity.Client.MsalUiRequiredException"/>.
</summary>
<param name="context">Context provided by ASP.NET Core.</param>
</member>
<member name="M:Microsoft.Identity.Web.AuthorizeForScopesAttribute.FindMsalUiRequiredExceptionIfAny(System.Exception)">
<summary>
Finds an MsalUiRequiredException in one of the inner exceptions.
</summary>
<param name="exception">Exception from which we look for an MsalUiRequiredException.</param>
<returns>The MsalUiRequiredException if there is one, null, otherwise.</returns>
</member>
<member name="T:Microsoft.Identity.Web.AzureFunctionsAuthenticationHttpContextExtension">
<summary>
Extensions for <see cref="T:Microsoft.Identity.Web.AzureFunctionsAuthenticationHttpContextExtension"/>.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.AzureFunctionsAuthenticationHttpContextExtension.AuthenticateAzureFunctionAsync(Microsoft.AspNetCore.Http.HttpContext)">
<summary>
Enables an Azure Function to act as/expose a protected web API, enabling bearer token authentication. Calling this method from your Azure function validates the token and exposes the identity of the user or app on behalf of which your function is called, in the HttpContext.User member, where your function can make use of it.
</summary>
<param name="httpContext">The current HTTP Context, such as req.HttpContext.</param>
<returns>A task indicating success or failure. In case of failure <see cref="T:Microsoft.AspNetCore.Mvc.UnauthorizedObjectResult"/>.</returns>
</member>
<member name="T:Microsoft.Identity.Web.TokenAcquisitionAppTokenCredential">
<summary>
Azure SDK token credential for App tokens based on the ITokenAcquisition service.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.TokenAcquisitionAppTokenCredential.#ctor(Microsoft.Identity.Web.ITokenAcquisition)">
<summary>
Constructor from an ITokenAcquisition service.
</summary>
<param name="tokenAcquisition">Token acquisition.</param>
</member>
<member name="M:Microsoft.Identity.Web.TokenAcquisitionAppTokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.TokenAcquisitionAppTokenCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
<inheritdoc/>
</member>
<member name="T:Microsoft.Identity.Web.TokenAcquisitionTokenCredential">
<summary>
Azure SDK token credential based on the ITokenAcquisition service.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.TokenAcquisitionTokenCredential.#ctor(Microsoft.Identity.Web.ITokenAcquisition)">
<summary>
Constructor from an ITokenAcquisition service.
</summary>
<param name="tokenAcquisition">Token acquisition.</param>
</member>
<member name="M:Microsoft.Identity.Web.TokenAcquisitionTokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.TokenAcquisitionTokenCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
<inheritdoc/>
</member>
<member name="T:Microsoft.Identity.Web.ClaimsPrincipalFactory">
<summary>
Factory class to create <see cref="T:System.Security.Claims.ClaimsPrincipal"/> objects.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.ClaimsPrincipalFactory.FromTenantIdAndObjectId(System.String,System.String)">
<summary>
Instantiate a <see cref="T:System.Security.Claims.ClaimsPrincipal"/> from an account object ID and tenant ID. This can
be useful when the web app subscribes to another service on behalf of the user
and then is called back by a notification where the user is identified by their tenant
ID and object ID (like in Microsoft Graph Web Hooks).
</summary>
<param name="tenantId">Tenant ID of the account.</param>
<param name="objectId">Object ID of the account in this tenant ID.</param>
<returns>A <see cref="T:System.Security.Claims.ClaimsPrincipal"/> containing these two claims.</returns>
<example>
<code>
private async Task GetChangedMessagesAsync(IEnumerable<Notification> notifications)
{
HttpContext.User = ClaimsPrincipalExtension.FromTenantIdAndObjectId(subscription.TenantId,
subscription.UserId);
foreach (var notification in notifications)
{
SubscriptionStore subscription =
subscriptionStore.GetSubscriptionInfo(notification.SubscriptionId);
string accessToken = await tokenAcquisition.GetAccessTokenForUserAsync(scopes);
...}
}
</code>
</example>
</member>
<member name="T:Microsoft.Identity.Web.CookiePolicyOptionsExtensions">
<summary>
Extension class containing cookie policies (work around for same site).
</summary>
</member>
<member name="M:Microsoft.Identity.Web.CookiePolicyOptionsExtensions.HandleSameSiteCookieCompatibility(Microsoft.AspNetCore.Builder.CookiePolicyOptions)">
<summary>
Handles SameSite cookie issue according to the https://docs.microsoft.com/en-us/aspnet/core/security/samesite?view=aspnetcore-3.1.
The default list of user agents that disallow "SameSite=None",
was taken from https://devblogs.microsoft.com/aspnet/upcoming-samesite-cookie-changes-in-asp-net-and-asp-net-core/.
</summary>
<param name="options"><see cref="T:Microsoft.AspNetCore.Builder.CookiePolicyOptions"/>to update.</param>
<returns><see cref="T:Microsoft.AspNetCore.Builder.CookiePolicyOptions"/> to chain.</returns>
</member>
<member name="M:Microsoft.Identity.Web.CookiePolicyOptionsExtensions.HandleSameSiteCookieCompatibility(Microsoft.AspNetCore.Builder.CookiePolicyOptions,System.Func{System.String,System.Boolean})">
<summary>
Handles SameSite cookie issue according to the docs: https://docs.microsoft.com/en-us/aspnet/core/security/samesite?view=aspnetcore-3.1
The default list of user agents that disallow "SameSite=None", was taken from https://devblogs.microsoft.com/aspnet/upcoming-samesite-cookie-changes-in-asp-net-and-asp-net-core/.
</summary>
<param name="options"><see cref="T:Microsoft.AspNetCore.Builder.CookiePolicyOptions"/>to update.</param>
<param name="disallowsSameSiteNone">If you don't want to use the default user agent list implementation,
the method sent in this parameter will be run against the user agent and if returned true, SameSite value will be set to Unspecified.
The default user agent list used can be found at: https://devblogs.microsoft.com/aspnet/upcoming-samesite-cookie-changes-in-asp-net-and-asp-net-core/. </param>
<returns><see cref="T:Microsoft.AspNetCore.Builder.CookiePolicyOptions"/> to chain.</returns>
</member>
<member name="M:Microsoft.Identity.Web.CookiePolicyOptionsExtensions.DisallowsSameSiteNone(System.String)">
<summary>
Checks if the specified user agent supports "SameSite=None" cookies.
</summary>
<param name="userAgent">Browser user agent.</param>
<remarks>
Incompatible user agents include:
<list type="bullet">
<item>Versions of Chrome from Chrome 51 to Chrome 66 (inclusive on both ends).</item>
<item>Versions of UC Browser on Android prior to version 12.13.2.</item>
<item>Versions of Safari and embedded browsers on MacOS 10.14 and all browsers on iOS 12.</item>
</list>
Reference: https://www.chromium.org/updates/same-site/incompatible-clients.
</remarks>
<returns>True, if the user agent does not allow "SameSite=None" cookie; otherwise, false.</returns>
</member>
<member name="T:Microsoft.Identity.Web.DefaultMicrosoftIdentityAuthenticationDelegatingHandlerFactory">
<summary>
The default implementation of <see cref="T:Microsoft.Identity.Web.IMicrosoftIdentityAuthenticationDelegatingHandlerFactory"/>.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.DefaultMicrosoftIdentityAuthenticationDelegatingHandlerFactory.#ctor(System.IServiceProvider)">
<summary>
Creates a new instance of <see cref="T:Microsoft.Identity.Web.DefaultMicrosoftIdentityAuthenticationDelegatingHandlerFactory"/>.
</summary>
<param name="serviceProvider">
The <see cref="T:System.IServiceProvider"/> to resolve dependencies from.
</param>
</member>
<member name="M:Microsoft.Identity.Web.DefaultMicrosoftIdentityAuthenticationDelegatingHandlerFactory.CreateAppHandler(System.String)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.DefaultMicrosoftIdentityAuthenticationDelegatingHandlerFactory.CreateUserHandler(System.String)">
<inheritdoc/>
</member>
<member name="T:Microsoft.Identity.Web.DownstreamWebApi">
<summary>
Implementation for the downstream web API.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApi.#ctor(Microsoft.Identity.Web.ITokenAcquisition,Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Net.Http.HttpClient,Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Identity.Web.MicrosoftIdentityOptions})">
<summary>
Constructor.
</summary>
<param name="tokenAcquisition">Token acquisition service.</param>
<param name="namedDownstreamWebApiOptions">Named options provider.</param>
<param name="httpClient">HTTP client.</param>
<param name="microsoftIdentityOptionsMonitor">Configuration options.</param>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApi.CallWebApiForUserAsync(System.String,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.Net.Http.StringContent)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApi.CallWebApiForUserAsync``2(System.String,``0,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApi.CallWebApiForAppAsync(System.String,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Net.Http.StringContent)">
<inheritdoc/>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApi.MergeOptions(System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions})">
<summary>
Merge the options from configuration and override from caller.
</summary>
<param name="optionsInstanceName">Named configuration.</param>
<param name="calledApiOptionsOverride">Delegate to override the configuration.</param>
</member>
<member name="T:Microsoft.Identity.Web.DownstreamWebApiExtensions">
<summary>
Extension methods to support downstream web API services.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiExtensions.AddDownstreamWebApi(Microsoft.Identity.Web.MicrosoftIdentityAppCallsWebApiAuthenticationBuilder,System.String,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Adds a named downstream web API service related to a specific configuration section.
</summary>
<param name="builder">Builder.</param>
<param name="serviceName">Name of the configuration for the service.
This is the name used when calling the service from controller/pages.</param>
<param name="configuration">Configuration.</param>
<returns>The builder for chaining.</returns>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiExtensions.AddDownstreamWebApi(Microsoft.Identity.Web.MicrosoftIdentityAppCallsWebApiAuthenticationBuilder,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions})">
<summary>
Adds a named downstream web API service initialized with delegates.
</summary>
<param name="builder">Builder.</param>
<param name="serviceName">Name of the configuration for the service.
This is the name which will be used when calling the service from controller/pages.</param>
<param name="configureOptions">Action to configure the options.</param>
<returns>The builder for chaining.</returns>
</member>
<member name="T:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions">
<summary>
Extensions for the downstream web API.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.GetForUserAsync``1(Microsoft.Identity.Web.IDownstreamWebApi,System.String,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)">
<summary>
Get a strongly typed response from the web API.
</summary>
<typeparam name="TOutput">Output type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="relativePath">Path to the API endpoint relative to the base URL specified in the configuration.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<returns>A strongly typed response from the web API.</returns>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.PostForUserAsync``2(Microsoft.Identity.Web.IDownstreamWebApi,System.String,System.String,``1,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)">
<summary>
Calls the web API with an HttpPost, providing strongly typed input and getting
strongly typed output.
</summary>
<typeparam name="TOutput">Output type.</typeparam>
<typeparam name="TInput">Input type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="relativePath">Path to the API endpoint relative to the base URL specified in the configuration.</param>
<param name="inputData">Input data sent to the API.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<returns>A strongly typed response from the web API.</returns>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.PutForUserAsync``1(Microsoft.Identity.Web.IDownstreamWebApi,System.String,System.String,``0,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)">
<summary>
Calls the web API endpoint with an HttpPut, providing strongly typed input data.
</summary>
<typeparam name="TInput">Input type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="relativePath">Path to the API endpoint relative to the base URL specified in the configuration.</param>
<param name="inputData">Input data sent to the API.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<returns>The value returned by the downstream web API.</returns>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.PutForUserAsync``2(Microsoft.Identity.Web.IDownstreamWebApi,System.String,System.String,``1,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)">
<summary>
Calls the web API endpoint with an HttpPut, provinding strongly typed input data
and getting back strongly typed data.
</summary>
<typeparam name="TOutput">Output type.</typeparam>
<typeparam name="TInput">Input type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="relativePath">Path to the API endpoint relative to the base URL specified in the configuration.</param>
<param name="inputData">Input data sent to the API.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<returns>A strongly typed response from the web API.</returns>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.CallWebApiForUserAsync``1(Microsoft.Identity.Web.IDownstreamWebApi,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)">
<summary>
Call a web API endpoint with an HttpGet,
and return strongly typed data.
</summary>
<typeparam name="TOutput">Output type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<returns>The value returned by the downstream web API.</returns>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.GetForUserAsync``1(Microsoft.Identity.Web.IDownstreamWebApi,System.String,``0,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)">
<summary>
Call a web API with a strongly typed input, with an HttpGet.
</summary>
<typeparam name="TInput">Input type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="inputData">Input data.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<returns>The value returned by the downstream web API.</returns>
</member>
<member name="T:Microsoft.Identity.Web.DownstreamWebApiOptions">
<summary>
Options passed-in to call downstream web APIs. To call Microsoft Graph, see rather
<c>MicrosoftGraphOptions</c> in the <c>Microsoft.Identity.Web.MicrosoftGraph</c> assembly.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.DownstreamWebApiOptions.BaseUrl">
<summary>
Base URL for the called downstream web API. For instance <c>"https://graph.microsoft.com/beta/".</c>.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.DownstreamWebApiOptions.RelativePath">
<summary>
Path relative to the <see cref="P:Microsoft.Identity.Web.DownstreamWebApiOptions.BaseUrl"/> (for instance "me").
</summary>
</member>
<member name="P:Microsoft.Identity.Web.DownstreamWebApiOptions.HttpMethod">
<summary>
HTTP method used to call this downstream web API (by default Get).
</summary>
</member>
<member name="P:Microsoft.Identity.Web.DownstreamWebApiOptions.CustomizeHttpRequestMessage">
<summary>
Provides an opportunity to customize the HttpRequestMessage. For example,
to customize the headers. This is called after the message was formed, including
the Authorization header, and just before the message is sent.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiOptions.Clone">
<summary>
Clone the options (to be able to override them).
</summary>
<returns>A clone of the options.</returns>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiOptions.GetApiUrl">
<summary>
Return the downstream web API URL.
</summary>
<returns>URL of the downstream web API.</returns>
</member>
<member name="M:Microsoft.Identity.Web.DownstreamWebApiOptions.System#ICloneable#Clone">
<summary>
Clone the options (to be able to override them).
</summary>
<returns>A clone of the options.</returns>
</member>
<member name="T:Microsoft.Identity.Web.IDownstreamWebApi">
<summary>
Interface used to call a downstream web API, for instance from controllers.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.IDownstreamWebApi.CallWebApiForUserAsync(System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.Net.Http.StringContent)">
<summary>
Calls the downstream web API for the user, based on a description of the
downstream web API in the configuration.
</summary>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="calledDownstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="calledDownstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="user">[Optional] Claims representing a user. This is useful on platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="content">HTTP context in the case where <see cref="P:Microsoft.Identity.Web.DownstreamWebApiOptions.HttpMethod"/> is
<see cref="P:System.Net.Http.HttpMethod.Patch"/>, <see cref="P:System.Net.Http.HttpMethod.Post"/>, <see cref="P:System.Net.Http.HttpMethod.Put"/>.</param>
<returns>An <see cref="T:System.Net.Http.HttpResponseMessage"/> that the application will process.</returns>
</member>
<member name="M:Microsoft.Identity.Web.IDownstreamWebApi.CallWebApiForUserAsync(System.String,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.Net.Http.StringContent)">
<summary>
Calls the downstream web API for the user, based on a description of the
downstream web API in the configuration.
</summary>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="calledDownstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<param name="calledDownstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="user">[Optional] Claims representing a user. This is useful on platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="content">HTTP context in the case where <see cref="P:Microsoft.Identity.Web.DownstreamWebApiOptions.HttpMethod"/> is
<see cref="P:System.Net.Http.HttpMethod.Patch"/>, <see cref="P:System.Net.Http.HttpMethod.Post"/>, <see cref="P:System.Net.Http.HttpMethod.Put"/>.</param>
<returns>An <see cref="T:System.Net.Http.HttpResponseMessage"/> that the application will process.</returns>
</member>
<member name="M:Microsoft.Identity.Web.IDownstreamWebApi.CallWebApiForUserAsync``2(System.String,``0,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal)">
<summary>
Calls a downstream web API consuming JSON with some data and returns data.
</summary>
<typeparam name="TInput">Input type.</typeparam>
<typeparam name="TOutput">Output type.</typeparam>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="input">Input parameter to the downstream web API.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<returns>The value returned by the downstream web API.</returns>
<example>
A list method that returns an IEnumerable<MyItem>>.
<code>
public Task<IEnumerable<MyItem>> GetAsync()
{
return _downstreamWebApi.CallWebApiForUserAsync<object, IEnumerable<MyItem>>(
ServiceName,
null,
options =>
{
options.RelativePath = $"api/todolist";
});
}
</code>
Example of editing.
<code>
public Task<MyItem> EditAsync(MyItem myItem)
{
return _downstreamWebApi.CallWebApiForUserAsync<MyItem, MyItem>(
ServiceName,
nyItem,
options =>
{
options.HttpMethod = HttpMethod.Patch;
options.RelativePath = $"api/todolist/{myItem.Id}";
});
}
</code>
</example>
</member>
<member name="M:Microsoft.Identity.Web.IDownstreamWebApi.CallWebApiForUserAsync``2(System.String,``0,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal)">
<summary>
Calls a downstream web API consuming JSON with some data and returns data.
</summary>
<typeparam name="TInput">Input type.</typeparam>
<typeparam name="TOutput">Output type.</typeparam>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="input">Input parameter to the downstream web API.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<returns>The value returned by the downstream web API.</returns>
<example>
A list method that returns an IEnumerable<MyItem>>.
<code>
public Task<IEnumerable<MyItem>> GetAsync()
{
return _downstreamWebApi.CallWebApiForUserAsync<object, IEnumerable<MyItem>>(
ServiceName,
null,
options =>
{
options.RelativePath = $"api/todolist";
});
}
</code>
Example of editing.
<code>
public Task<MyItem> EditAsync(MyItem myItem)
{
return _downstreamWebApi.CallWebApiForUserAsync<MyItem, MyItem>(
ServiceName,
nyItem,
options =>
{
options.HttpMethod = HttpMethod.Patch;
options.RelativePath = $"api/todolist/{myItem.Id}";
});
}
</code>
</example>
</member>
<member name="M:Microsoft.Identity.Web.IDownstreamWebApi.CallWebApiForAppAsync(System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Net.Http.StringContent)">
<summary>
Calls the downstream web API for the app, with the required scopes.
</summary>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="content">HTTP content in the case where <see cref="P:Microsoft.Identity.Web.DownstreamWebApiOptions.HttpMethod"/> is
<see cref="P:System.Net.Http.HttpMethod.Patch"/>, <see cref="P:System.Net.Http.HttpMethod.Post"/>, <see cref="P:System.Net.Http.HttpMethod.Put"/>.</param>
<returns>An <see cref="T:System.Net.Http.HttpResponseMessage"/> that the application will process.</returns>
</member>
<member name="M:Microsoft.Identity.Web.IDownstreamWebApi.CallWebApiForAppAsync(System.String,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Net.Http.StringContent)">
<summary>
Calls the downstream web API for the app, with the required scopes.
</summary>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions"/>,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride"/>
needs to be set.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName"/>.</param>
<param name="content">HTTP content in the case where <see cref="P:Microsoft.Identity.Web.DownstreamWebApiOptions.HttpMethod"/> is
<see cref="P:System.Net.Http.HttpMethod.Patch"/>, <see cref="P:System.Net.Http.HttpMethod.Post"/>, <see cref="P:System.Net.Http.HttpMethod.Put"/>.</param>
<returns>An <see cref="T:System.Net.Http.HttpResponseMessage"/> that the application will process.</returns>
</member>
<member name="T:Microsoft.Identity.Web.IMicrosoftIdentityAuthenticationDelegatingHandlerFactory">
<summary>
Interface to a class that provides the <see cref="T:System.Net.Http.DelegatingHandler"/> that
adds an authorization header with a token for the application.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.IMicrosoftIdentityAuthenticationDelegatingHandlerFactory.CreateAppHandler(System.String)">
<summary>
Creates an instance of a <see cref="T:System.Net.Http.DelegatingHandler"/> that adds
an authorization header with a token for an application.
</summary>
<param name="serviceName">
Name of the service describing the downstream web API. Used to
retrieve the appropriate config section.
</param>
<returns>
The <see cref="T:System.Net.Http.DelegatingHandler"/>.
</returns>
</member>
<member name="M:Microsoft.Identity.Web.IMicrosoftIdentityAuthenticationDelegatingHandlerFactory.CreateUserHandler(System.String)">
<summary>
Creates an instance of a <see cref="T:System.Net.Http.DelegatingHandler"/> that adds
an authorization header with a token on behalf of the current user.
</summary>
<param name="serviceName">
Name of the service describing the downstream web API. Used to
retrieve the appropriate config section.
</param>
<returns>
The <see cref="T:System.Net.Http.DelegatingHandler"/>.
</returns>
</member>
<member name="T:Microsoft.Identity.Web.MicrosoftIdentityAppAuthenticationMessageHandler">
<summary>
A DelegatingHandler implementation that add an authorization header with a token for the application.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAppAuthenticationMessageHandler.#ctor(Microsoft.Identity.Web.ITokenAcquisition,Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions},System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Identity.Web.MicrosoftIdentityAppAuthenticationMessageHandler"/> class.
</summary>
<param name="tokenAcquisition">Token acquisition service.</param>
<param name="namedMessageHandlerOptions">Named options provider.</param>
<param name="serviceName">Name of the service describing the downstream web API.</param>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAppAuthenticationMessageHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
<inheritdoc/>
</member>
<member name="T:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseMessageHandler">
<summary>
Base class for Microsoft Identity authentication message handlers.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseMessageHandler.TokenAcquisition">
<summary>
Gets the token acquisition service.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseMessageHandler.#ctor(Microsoft.Identity.Web.ITokenAcquisition,Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions},System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseMessageHandler"/> class.
</summary>
<param name="tokenAcquisition">Token acquisition service.</param>
<param name="namedMessageHandlerOptions">Named options provider.</param>
<param name="serviceName">Name of the service describing the downstream web API.</param>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseMessageHandler.GetOptionsForRequest(System.Net.Http.HttpRequestMessage)">
<summary>
Gets the options for the specified request.
</summary>
<param name="request">The request.</param>
<returns>The configured options.</returns>
</member>
<member name="T:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions">
<summary>
Base options passed-in to authenticate with Microsoft Identity.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions.Scopes">
<summary>
Space separated scopes required to call the downstream web API.
For instance "user.read mail.read".
</summary>
</member>
<member name="P:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions.Tenant">
<summary>
[Optional] tenant ID. This is used for specific scenarios where
the application needs to call a downstream web API on behalf of a user in several tenants.
It would mostly be used from code, not from the configuration.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions.UserFlow">
<summary>
[Optional]. User flow (in the case of a B2C downstream web API). If not
specified, the B2C downstream web API will be called with the default user flow from
<see cref="P:Microsoft.Identity.Web.MicrosoftIdentityOptions.DefaultUserFlow"/>.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions.IsProofOfPossessionRequest">
<summary>
Modifies the token acquisition request so that the acquired token is a Proof of Possession token (PoP),
rather than a Bearer token.
PoP tokens are similar to Bearer tokens, but are bound to the HTTP request and to a cryptographic key,
which MSAL can manage. See https://aka.ms/msal-net-pop.
Set to true to enable PoP tokens automatically.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions.TokenAcquisitionOptions">
<summary>
Options passed-in to create the token acquisition object which calls into MSAL .NET.
</summary>
</member>
<member name="P:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions.AuthenticationScheme">
<summary>
Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationBaseOptions.GetScopes">
<summary>
Returns the scopes.
</summary>
<returns>Scopes.</returns>
</member>
<member name="T:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions">
<summary>
Extension for IHttpClientBuilder for startup initialization of Microsoft Identity authentication handlers.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityUserAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Adds a named Microsoft Identity user authentication message handler related to a specific configuration section.
</summary>
<param name="builder">Builder.</param>
<param name="configuration">Configuration.</param>
<returns>The builder for chaining.</returns>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityUserAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.String,Microsoft.Extensions.Configuration.IConfiguration)">
<inheritdoc cref="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityUserAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,Microsoft.Extensions.Configuration.IConfiguration)" />
<param name="serviceName">Name of the configuration for the service.</param>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityUserAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions})">
<summary>
Adds a named Microsoft Identity user authentication message handler initialized with delegates.
</summary>
<param name="builder">Builder.</param>
<param name="configureOptions">Action to configure the options.</param>
<returns>The builder for chaining.</returns>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityUserAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.String,System.Action{Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions})">
<inheritdoc cref="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityUserAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions})"/>
<param name="serviceName">Name of the configuration for the service.</param>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityAppAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Adds a named Microsoft Identity application authentication message handler related to a specific configuration section.
</summary>
<param name="builder">Builder.</param>
<param name="configuration">Configuration.</param>
<returns>The builder for chaining.</returns>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityAppAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.String,Microsoft.Extensions.Configuration.IConfiguration)">
<inheritdoc cref="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityAppAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,Microsoft.Extensions.Configuration.IConfiguration)"/>
<param name="serviceName">Name of the configuration for the service.</param>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityAppAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions})">
<summary>
Adds a named Microsoft Identity application authentication message handler initialized with delegates.
</summary>
<param name="builder">Builder.</param>
<param name="configureOptions">Action to configure the options.</param>
<returns>The builder for chaining.</returns>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityAppAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.String,System.Action{Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions})">
<inheritdoc cref="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityAppAuthenticationHandler(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions})"/>
<param name="serviceName">Name of the configuration for the service.</param>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerHttpClientBuilderExtensions.AddMicrosoftIdentityAuthenticationHandlerCore(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{Microsoft.Identity.Web.IMicrosoftIdentityAuthenticationDelegatingHandlerFactory,System.Net.Http.DelegatingHandler})">
<summary>
Adds the common configuration for message handlers.
</summary>
<param name="builder">
The <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/> to configure.
</param>
<param name="configureHandler">
A Func that takes the <see cref="T:Microsoft.Identity.Web.IMicrosoftIdentityAuthenticationDelegatingHandlerFactory"/> and returns
the <see cref="T:System.Net.Http.DelegatingHandler"/>. This func allows us to reuse the logic to add message handlers,
while allowing the caller to decide if it needs an app handler or a user handler.
</param>
</member>
<member name="T:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions">
<summary>
Options passed-in to Microsoft Identity message handlers.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions.Clone">
<summary>
Clone the options (to be able to override them).
</summary>
<returns>A clone of the options.</returns>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions.System#ICloneable#Clone">
<summary>
Clone the options (to be able to override them).
</summary>
<returns>A clone of the options.</returns>
</member>
<member name="T:Microsoft.Identity.Web.MicrosoftIdentityUserAuthenticationMessageHandler">
<summary>
A DelegatingHandler implementation that add an authorization header with a token on behalf of the current user.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityUserAuthenticationMessageHandler.#ctor(Microsoft.Identity.Web.ITokenAcquisition,Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Identity.Web.MicrosoftIdentityAuthenticationMessageHandlerOptions},Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Identity.Web.MicrosoftIdentityOptions},System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Identity.Web.MicrosoftIdentityUserAuthenticationMessageHandler"/> class.
</summary>
<param name="tokenAcquisition">Token acquisition service.</param>
<param name="namedMessageHandlerOptions">Named options provider.</param>
<param name="microsoftIdentityOptions">Configuration options.</param>
<param name="serviceName">Name of the service describing the downstream web API.</param>
</member>
<member name="M:Microsoft.Identity.Web.MicrosoftIdentityUserAuthenticationMessageHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
<inheritdoc/>
</member>
<member name="T:Microsoft.Identity.Web.Extensions">
<summary>
Extension methods.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.Extensions.ContainsAny(System.String,System.String[])">
<summary>Determines whether the specified string collection contains any.</summary>
<param name="searchFor">The search for.</param>
<param name="stringCollection">The string collection.</param>
<returns>
<c>true</c> if the specified string collection contains any; otherwise, <c>false</c>.</returns>
</member>
<member name="T:Microsoft.Identity.Web.ILoginErrorAccessor">
<summary>
Provides access to get or set the current error status.
The default implementation will use TempData and be enabled when run under Development.
</summary>
</member>
<member name="M:Microsoft.Identity.Web.ILoginErrorAccessor.GetMessage(Microsoft.AspNetCore.Http.HttpContext)">
<summary>
Gets the error message for the current request.
</summary>
<param name="context">Current <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
<returns>The current error message if available.</returns>
</member>
<member name="M:Microsoft.Identity.Web.ILoginErrorAccessor.SetMessage(Microsoft.AspNetCore.Http.HttpContext,System.String)">
<summary>
Sets the error message for the current request.