-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMicrosoft.AspNetCore.Authentication.Abstractions.xml
732 lines (732 loc) · 47.3 KB
/
Microsoft.AspNetCore.Authentication.Abstractions.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.AspNetCore.Authentication.Abstractions</name>
</assembly>
<members>
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticateResult">
<summary>
Contains the result of an Authenticate call
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Succeeded">
<summary>
If a ticket was produced, authenticate was successful.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Ticket">
<summary>
The authentication ticket.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Principal">
<summary>
Gets the claims-principal with authenticated user identities.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Properties">
<summary>
Additional state values for the authentication session.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Failure">
<summary>
Holds failure information from the authentication.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.None">
<summary>
Indicates that there was no information returned for this authentication scheme.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Success(Microsoft.AspNetCore.Authentication.AuthenticationTicket)">
<summary>
Indicates that authentication was successful.
</summary>
<param name="ticket">The ticket representing the authentication result.</param>
<returns>The result.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.NoResult">
<summary>
Indicates that there was no information returned for this authentication scheme.
</summary>
<returns>The result.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.Exception)">
<summary>
Indicates that there was a failure during authentication.
</summary>
<param name="failure">The failure exception.</param>
<returns>The result.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.String)">
<summary>
Indicates that there was a failure during authentication.
</summary>
<param name="failureMessage">The failure message.</param>
<returns>The result.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions">
<summary>
Extension methods to expose Authentication on HttpContext.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext)">
<summary>
Extension method for authenticate using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/> scheme.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/>.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
<summary>
Extension method for authenticate.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/>.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
<summary>
Extension method for Challenge.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<returns>The result.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext)">
<summary>
Extension method for authenticate using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/> scheme.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Extension method for authenticate using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/> scheme.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Extension method for Challenge.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
<summary>
Extension method for Forbid.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext)">
<summary>
Extension method for Forbid using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/> scheme..
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Extension method for Forbid.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Extension method for Forbid.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal)">
<summary>
Extension method for SignIn.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="principal">The user.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.Security.Claims.ClaimsPrincipal)">
<summary>
Extension method for SignIn using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="principal">The user.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Extension method for SignIn using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="principal">The user.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Extension method for SignIn.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="principal">The user.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext)">
<summary>
Extension method for SignOut using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Extension method for SignOut using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
<summary>
Extension method for SignOut.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<returns>The task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Extension method for SignOut.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<returns></returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.GetTokenAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.String)">
<summary>
Extension method for getting the value of an authentication token.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="tokenName">The name of the token.</param>
<returns>The value of the token.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.GetTokenAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
<summary>
Extension method for getting the value of an authentication token.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="tokenName">The name of the token.</param>
<returns>The value of the token.</returns>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.Schemes">
<summary>
Returns the schemes in the order they were added (important for request handling priority)
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.SchemeMap">
<summary>
Maps schemes by name.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationOptions.AddScheme(System.String,System.Action{Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder})">
<summary>
Adds an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>.
</summary>
<param name="name">The name of the scheme being added.</param>
<param name="configureBuilder">Configures the scheme.</param>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationOptions.AddScheme``1(System.String,System.String)">
<summary>
Adds an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>.
</summary>
<typeparam name="THandler">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> responsible for the scheme.</typeparam>
<param name="name">The name of the scheme being added.</param>
<param name="displayName">The display name for the scheme.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme">
<summary>
Used as the fallback default scheme for all the other defaults.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme">
<summary>
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme">
<summary>
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme">
<summary>
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme">
<summary>
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme">
<summary>
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties">
<summary>
Dictionary used to store state values about the authentication session.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.#ctor(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class
</summary>
<param name="items"></param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items">
<summary>
State values about the authentication session.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.IsPersistent">
<summary>
Gets or sets whether the authentication session is persisted across multiple requests.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.RedirectUri">
<summary>
Gets or sets the full path or absolute URI to be used as an http redirect response value.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.IssuedUtc">
<summary>
Gets or sets the time at which the authentication ticket was issued.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.ExpiresUtc">
<summary>
Gets or sets the time at which the authentication ticket expires.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.AllowRefresh">
<summary>
Gets or sets if refreshing the authentication session should be allowed.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme">
<summary>
AuthenticationSchemes assign a name to a specific <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/>
handlerType.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationScheme.#ctor(System.String,System.String,System.Type)">
<summary>
Constructor.
</summary>
<param name="name">The name for the authentication scheme.</param>
<param name="displayName">The display name for the authentication scheme.</param>
<param name="handlerType">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type that handles this scheme.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.Name">
<summary>
The name of the authentication scheme.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.DisplayName">
<summary>
The display name for the scheme. Null is valid and used for non user facing schemes.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.HandlerType">
<summary>
The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type that handles this scheme.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder">
<summary>
Used to build <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.#ctor(System.String)">
<summary>
Constructor.
</summary>
<param name="name">The name of the scheme being built.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.Name">
<summary>
The name of the scheme being built.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.DisplayName">
<summary>
The display name for the scheme being built.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.HandlerType">
<summary>
The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type responsible for this scheme.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.Build">
<summary>
Builds the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> instance.
</summary>
<returns></returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket">
<summary>
Contains user identity information as well as additional authentication state.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTicket.#ctor(System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket"/> class
</summary>
<param name="principal">the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> that represents the authenticated user.</param>
<param name="properties">additional properties that can be consumed by the user or runtime.</param>
<param name="authenticationScheme">the authentication middleware that was responsible for this ticket.</param>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTicket.#ctor(System.Security.Claims.ClaimsPrincipal,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket"/> class
</summary>
<param name="principal">the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> that represents the authenticated user.</param>
<param name="authenticationScheme">the authentication middleware that was responsible for this ticket.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.AuthenticationScheme">
<summary>
Gets the authentication type.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.Principal">
<summary>
Gets the claims-principal with authenticated user identities.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.Properties">
<summary>
Additional state values for the authentication session.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationToken">
<summary>
Name/Value representing an token.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationToken.Name">
<summary>
Name.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationToken.Value">
<summary>
Value.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationFeature">
<summary>
Used to capture path info so redirects can be computed properly within an app.Map().
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.IAuthenticationFeature.OriginalPathBase">
<summary>
The original path base.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.IAuthenticationFeature.OriginalPath">
<summary>
The original path.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler">
<summary>
Created per request to handle authentication for to a particular scheme.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.InitializeAsync(Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Http.HttpContext)">
<summary>
The handler should initialize anything it needs from the request and scheme here.
</summary>
<param name="scheme">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> scheme.</param>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<returns></returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.AuthenticateAsync">
<summary>
Authentication behavior.
</summary>
<returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/> result.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.ChallengeAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Challenge behavior.
</summary>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
<returns>A task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.ForbidAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Forbid behavior.
</summary>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
<returns>A task.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider">
<summary>
Provides the appropriate IAuthenticationHandler instance for the authenticationScheme and request.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider.GetHandlerAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
<summary>
Returns the handler instance that will be used.
</summary>
<param name="context">The context.</param>
<param name="authenticationScheme">The name of the authentication scheme being handled.</param>
<returns>The handler instance.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler">
<summary>
Used to determine if a handler wants to participate in request processing.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler.HandleRequestAsync">
<summary>
Returns true if request processing should stop.
</summary>
<returns></returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider">
<summary>
Responsible for managing what authenticationSchemes are supported.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetAllSchemesAsync">
<summary>
Returns all currently registered <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.
</summary>
<returns>All currently registered <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetSchemeAsync(System.String)">
<summary>
Returns the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> matching the name, or null.
</summary>
<param name="name">The name of the authenticationScheme.</param>
<returns>The scheme or null if not found.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultAuthenticateSchemeAsync">
<summary>
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/>.
Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
</summary>
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync">
<summary>
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/>.
Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
</summary>
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultForbidSchemeAsync">
<summary>
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.
Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync"/> .
</summary>
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignInSchemeAsync">
<summary>
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
</summary>
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignOutSchemeAsync">
<summary>
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignInSchemeAsync"/> .
</summary>
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.AddScheme(Microsoft.AspNetCore.Authentication.AuthenticationScheme)">
<summary>
Registers a scheme for use by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
</summary>
<param name="scheme">The scheme.</param>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.RemoveScheme(System.String)">
<summary>
Removes a scheme, preventing it from being used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
</summary>
<param name="name">The name of the authenticationScheme being removed.</param>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetRequestHandlerSchemesAsync">
<summary>
Returns the schemes in priority order for request handling.
</summary>
<returns>The schemes in priority order for request handling</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationService">
<summary>
Used to provide authentication.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
<summary>
Authenticate for the specified authentication scheme.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
<param name="scheme">The name of the authentication scheme.</param>
<returns>The result.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Challenge the specified authentication scheme.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
<returns>A task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Forbids the specified authentication scheme.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
<returns>A task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Sign a principal in for the specified authentication scheme.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to sign in.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
<returns>A task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Sign out the specified authentication scheme.
</summary>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
<returns>A task.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler">
<summary>
Used to determine if a handler supports SignIn.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler.SignInAsync(System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Handle sign in.
</summary>
<param name="user">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> user.</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
<returns>A task.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler">
<summary>
Used to determine if a handler supports SignOut.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler.SignOutAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Signout behavior.
</summary>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
<returns>A task.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.IClaimsTransformation">
<summary>
Used by the <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/> for claims transformation.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.IClaimsTransformation.TransformAsync(System.Security.Claims.ClaimsPrincipal)">
<summary>
Provides a central transformation point to change the specified principal.
</summary>
<param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to transform.</param>
<returns>The transformed principal.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions">
<summary>
Extension methods for storing authentication tokens in <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.StoreTokens(Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authentication.AuthenticationToken})">
<summary>
Stores a set of authentication tokens, after removing any old tokens.
</summary>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<param name="tokens">The tokens to store.</param>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenValue(Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.String)">
<summary>
Returns the value of a token.
</summary>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<param name="tokenName">The token name.</param>
<returns>The token value.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokens(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Returns all of the AuthenticationTokens contained in the properties.
</summary>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
<returns>The authentication toekns.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenAsync(Microsoft.AspNetCore.Authentication.IAuthenticationService,Microsoft.AspNetCore.Http.HttpContext,System.String)">
<summary>
Extension method for getting the value of an authentication token.
</summary>
<param name="auth">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.</param>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="tokenName">The name of the token.</param>
<returns>The value of the token.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenAsync(Microsoft.AspNetCore.Authentication.IAuthenticationService,Microsoft.AspNetCore.Http.HttpContext,System.String,System.String)">
<summary>
Extension method for getting the value of an authentication token.
</summary>
<param name="auth">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.</param>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
<param name="scheme">The name of the authentication scheme.</param>
<param name="tokenName">The name of the token.</param>
<returns>The value of the token.</returns>
</member>
</members>
</doc>