-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMicrosoft.AspNetCore.Authentication.xml
622 lines (621 loc) · 34.5 KB
/
Microsoft.AspNetCore.Authentication.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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.AspNetCore.Authentication</name>
</assembly>
<members>
<member name="T:Microsoft.Extensions.Internal.SecurityHelper">
<summary>
Helper code used when implementing authentication middleware
</summary>
</member>
<member name="M:Microsoft.Extensions.Internal.SecurityHelper.MergeUserPrincipal(System.Security.Claims.ClaimsPrincipal,System.Security.Claims.ClaimsPrincipal)">
<summary>
Add all ClaimsIdentities from an additional ClaimPrincipal to the ClaimsPrincipal
Merges a new claims principal, placing all new identities first, and eliminating
any empty unauthenticated identities from context.User
</summary>
<param name="existingPrincipal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> containing existing <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
<param name="additionalPrincipal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> containing <see cref="T:System.Security.Claims.ClaimsIdentity"/> to be added.</param>
</member>
<member name="T:Microsoft.Extensions.DependencyInjection.AuthenticationServiceCollectionExtensions">
<summary>
Extension methods for setting up authentication services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Builder.AuthAppBuilderExtensions">
<summary>
Extension methods to add authentication capabilities to an HTTP application pipeline.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Builder.AuthAppBuilderExtensions.UseAuthentication(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
<summary>
Adds the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationMiddleware"/> to the specified <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>, which enables authentication capabilities.
</summary>
<param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> to add the middleware to.</param>
<returns>A reference to this instance after the operation has completed.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder">
<summary>
Used to configure authentication
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationBuilder.#ctor(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
<summary>
Constructor.
</summary>
<param name="services">The services being configured.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationBuilder.Services">
<summary>
The services being configured.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationBuilder.AddScheme``2(System.String,System.String,System.Action{``0})">
<summary>
Adds a <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> which can be used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
</summary>
<typeparam name="TOptions">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions"/> type to configure the handler."/>.</typeparam>
<typeparam name="THandler">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1"/> used to handle this scheme.</typeparam>
<param name="authenticationScheme">The name of this scheme.</param>
<param name="displayName">The display name of this scheme.</param>
<param name="configureOptions">Used to configure the scheme options.</param>
<returns>The builder.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationBuilder.AddScheme``2(System.String,System.Action{``0})">
<summary>
Adds a <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> which can be used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
</summary>
<typeparam name="TOptions">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions"/> type to configure the handler."/>.</typeparam>
<typeparam name="THandler">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1"/> used to handle this scheme.</typeparam>
<param name="authenticationScheme">The name of this scheme.</param>
<param name="configureOptions">Used to configure the scheme options.</param>
<returns>The builder.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationBuilder.AddRemoteScheme``2(System.String,System.String,System.Action{``0})">
<summary>
Adds a <see cref="T:Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler`1"/> based <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> that supports remote authentication
which can be used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
</summary>
<typeparam name="TOptions">The <see cref="T:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions"/> type to configure the handler."/>.</typeparam>
<typeparam name="THandler">The <see cref="T:Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler`1"/> used to handle this scheme.</typeparam>
<param name="authenticationScheme">The name of this scheme.</param>
<param name="displayName">The display name of this scheme.</param>
<param name="configureOptions">Used to configure the scheme options.</param>
<returns>The builder.</returns>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.Events">
<summary>
The handler calls methods on the events which give the application control at certain points where processing is occurring.
If it is not provided a default instance is supplied which does nothing when the methods are called.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.InitializeAsync(Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Http.HttpContext)">
<summary>
Initialize the handler, resolve the options and validate them.
</summary>
<param name="scheme"></param>
<param name="context"></param>
<returns></returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.InitializeEventsAsync">
<summary>
Initializes the events object, called once per request by <see cref="M:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.InitializeAsync(Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Http.HttpContext)"/>.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.CreateEventsAsync">
<summary>
Creates a new instance of the events instance.
</summary>
<returns>A new instance of the events instance.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.InitializeHandlerAsync">
<summary>
Called after options/events have been initialized for the handler to finish initializing itself.
</summary>
<returns>A task</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.HandleAuthenticateOnceAsync">
<summary>
Used to ensure HandleAuthenticateAsync is only invoked once. The subsequent calls
will return the same authenticate result.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.HandleAuthenticateOnceSafeAsync">
<summary>
Used to ensure HandleAuthenticateAsync is only invoked once safely. The subsequent
calls will return the same authentication result. Any exceptions will be converted
into a failed authentication result containing the exception.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.HandleForbiddenAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Override this method to handle Forbid.
</summary>
<param name="properties"></param>
<returns>A Task.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1.HandleChallengeAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Override this method to deal with 401 challenge concerns, if an authentication scheme in question
deals an authentication interaction as part of it's request flow. (like adding a response header, or
changing the 401 result to 302 of a login page or external sign-in location.)
</summary>
<param name="properties"></param>
<returns>A Task.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions">
<summary>
Contains the options used by the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1"/>.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions.Validate">
<summary>
Check that the options are valid. Should throw an exception if things are not ok.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions.ClaimsIssuer">
<summary>
Gets or sets the issuer that should be used for any claims that are created
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions.Events">
<summary>
Instance used for events
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions.EventsType">
<summary>
If set, will be used as the service type to get the Events instance instead of the property.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.Base64UrlTextEncoder.Encode(System.Byte[])">
<summary>
Encodes supplied data into Base64 and replaces any URL encodable characters into non-URL encodable
characters.
</summary>
<param name="data">Data to be encoded.</param>
<returns>Base64 encoded string modified with non-URL encodable characters</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.Base64UrlTextEncoder.Decode(System.String)">
<summary>
Decodes supplied string by replacing the non-URL encodable characters with URL encodable characters and
then decodes the Base64 string.
</summary>
<param name="text">The string to be decoded.</param>
<returns>The decoded data.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.BaseContext`1">
<summary>
Base class used by other context classes.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.BaseContext`1.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,`0)">
<summary>
Constructor.
</summary>
<param name="context">The context.</param>
<param name="scheme">The authentication scheme.</param>
<param name="options">The authentication options associated with the scheme.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.BaseContext`1.Scheme">
<summary>
The authentication scheme.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.BaseContext`1.Options">
<summary>
Gets the authentication options associated with the scheme.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.BaseContext`1.HttpContext">
<summary>
The context.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.BaseContext`1.Request">
<summary>
The request.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.BaseContext`1.Response">
<summary>
The response.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.HandleRequestContext`1.Result">
<summary>
The <see cref="T:Microsoft.AspNetCore.Authentication.HandleRequestResult"/> which is used by the handler.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.HandleRequestContext`1.HandleResponse">
<summary>
Discontinue all processing for this request and return to the client.
The caller is responsible for generating the full response.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.HandleRequestContext`1.SkipHandler">
<summary>
Discontinue processing the request in the current handler.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.PrincipalContext`1">
<summary>
Base context for authentication events which deal with a ClaimsPrincipal.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.PrincipalContext`1.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,`0,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Constructor.
</summary>
<param name="context">The context.</param>
<param name="scheme">The authentication scheme.</param>
<param name="options">The authentication options associated with the scheme.</param>
<param name="properties">The authentication properties.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.PrincipalContext`1.Principal">
<summary>
Gets the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> containing the user claims.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.PropertiesContext`1">
<summary>
Base context for authentication events which contain <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.PropertiesContext`1.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,`0,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Constructor.
</summary>
<param name="context">The context.</param>
<param name="scheme">The authentication scheme.</param>
<param name="options">The authentication options associated with the scheme.</param>
<param name="properties">The authentication properties.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.PropertiesContext`1.Properties">
<summary>
Gets or sets the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.RedirectContext`1">
<summary>
Context passed for redirect events.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.RedirectContext`1.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,`0,Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.String)">
<summary>
Creates a new context object.
</summary>
<param name="context">The HTTP request context</param>
<param name="scheme">The scheme data</param>
<param name="options">The handler options</param>
<param name="redirectUri">The initial redirect URI</param>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RedirectContext`1.RedirectUri">
<summary>
Gets or Sets the URI used for the redirect operation.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.RemoteAuthenticationContext`1">
<summary>
Base context for remote authentication.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.RemoteAuthenticationContext`1.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,`0,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
<summary>
Constructor.
</summary>
<param name="context">The context.</param>
<param name="scheme">The authentication scheme.</param>
<param name="options">The authentication options associated with the scheme.</param>
<param name="properties">The authentication properties.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationContext`1.Principal">
<summary>
Gets the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> containing the user claims.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationContext`1.Properties">
<summary>
Gets or sets the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.RemoteAuthenticationContext`1.Success">
<summary>
Calls success creating a ticket with the <see cref="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationContext`1.Principal"/> and <see cref="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationContext`1.Properties"/>.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.RemoteAuthenticationEvents.RemoteFailure(Microsoft.AspNetCore.Authentication.RemoteFailureContext)">
<summary>
Invoked when there is a remote failure
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.RemoteAuthenticationEvents.TicketReceived(Microsoft.AspNetCore.Authentication.TicketReceivedContext)">
<summary>
Invoked after the remote ticket has been received.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.RemoteFailureContext">
<summary>
Provides failure context information to handler providers.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteFailureContext.Failure">
<summary>
User friendly error message for the error.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.ResultContext`1">
<summary>
Base context for events that produce AuthenticateResults.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.ResultContext`1.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,`0)">
<summary>
Constructor.
</summary>
<param name="context">The context.</param>
<param name="scheme">The authentication scheme.</param>
<param name="options">The authentication options associated with the scheme.</param>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.ResultContext`1.Principal">
<summary>
Gets or sets the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> containing the user claims.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.ResultContext`1.Properties">
<summary>
Gets or sets the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.ResultContext`1.Result">
<summary>
Gets the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/> result.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.ResultContext`1.Success">
<summary>
Calls success creating a ticket with the <see cref="P:Microsoft.AspNetCore.Authentication.ResultContext`1.Principal"/> and <see cref="P:Microsoft.AspNetCore.Authentication.ResultContext`1.Properties"/>.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.ResultContext`1.NoResult">
<summary>
Indicates that there was no information returned for this authentication scheme.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.ResultContext`1.Fail(System.Exception)">
<summary>
Indicates that there was a failure during authentication.
</summary>
<param name="failure"></param>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.ResultContext`1.Fail(System.String)">
<summary>
Indicates that there was a failure during authentication.
</summary>
<param name="failureMessage"></param>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.TicketReceivedContext">
<summary>
Provides context information to handler providers.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.Internal.RequestPathBaseCookieBuilder">
<summary>
A cookie builder that sets <see cref="P:Microsoft.AspNetCore.Http.CookieOptions.Path"/> to the request path base.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.Internal.RequestPathBaseCookieBuilder.AdditionalPath">
<summary>
Gets an optional value that is appended to the request path base.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.ISystemClock">
<summary>
Abstracts the system clock to facilitate testing.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.ISystemClock.UtcNow">
<summary>
Retrieves the current system time in UTC.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.Resources.Exception_DefaultDpapiRequiresAppNameKey">
<summary>
The default data protection provider may only be used when the IApplicationBuilder.Properties contains an appropriate 'host.AppName' key.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.Resources.FormatException_DefaultDpapiRequiresAppNameKey">
<summary>
The default data protection provider may only be used when the IApplicationBuilder.Properties contains an appropriate 'host.AppName' key.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.Resources.Exception_UnhookAuthenticationStateType">
<summary>
The state passed to UnhookAuthentication may only be the return value from HookAuthentication.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.Resources.FormatException_UnhookAuthenticationStateType">
<summary>
The state passed to UnhookAuthentication may only be the return value from HookAuthentication.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.Resources.Exception_AuthenticationTokenDoesNotProvideSyncMethods">
<summary>
The AuthenticationTokenProvider's required synchronous events have not been registered.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.Resources.FormatException_AuthenticationTokenDoesNotProvideSyncMethods">
<summary>
The AuthenticationTokenProvider's required synchronous events have not been registered.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.Resources.Exception_OptionMustBeProvided">
<summary>
The '{0}' option must be provided.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.Resources.FormatException_OptionMustBeProvided(System.Object)">
<summary>
The '{0}' option must be provided.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.Resources.Exception_RemoteSignInSchemeCannotBeSelf">
<summary>
The SignInScheme for a remote authentication handler cannot be set to itself. If it was not explicitly set, the AuthenticationOptions.DefaultSignInScheme or DefaultScheme is used.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.Resources.FormatException_RemoteSignInSchemeCannotBeSelf">
<summary>
The SignInScheme for a remote authentication handler cannot be set to itself. If it was not explicitly set, the AuthenticationOptions.DefaultSignInScheme or DefaultScheme is used.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler`1.Events">
<summary>
The handler calls methods on the events which give the application control at certain points where processing is occurring.
If it is not provided a default instance is supplied which does nothing when the methods are called.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler`1.HandleRemoteAuthenticateAsync">
<summary>
Authenticate the user identity with the identity provider.
The method process the request on the endpoint defined by CallbackPath.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions">
<summary>
Contains the options used by the <see cref="T:Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler`1"/>.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.#ctor">
<summary>
Initializes a new <see cref="T:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions"/>.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.Validate">
<summary>
Check that the options are valid. Should throw an exception if things are not ok.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.BackchannelTimeout">
<summary>
Gets or sets timeout value in milliseconds for back channel communications with the remote identity provider.
</summary>
<value>
The back channel timeout.
</value>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.BackchannelHttpHandler">
<summary>
The HttpMessageHandler used to communicate with remote identity provider.
This cannot be set at the same time as BackchannelCertificateValidator unless the value
can be downcast to a WebRequestHandler.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.Backchannel">
<summary>
Used to communicate with the remote identity provider.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.DataProtectionProvider">
<summary>
Gets or sets the type used to secure data.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.CallbackPath">
<summary>
The request path within the application's base path where the user-agent will be returned.
The middleware will process this request when it arrives.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.SignInScheme">
<summary>
Gets or sets the authentication scheme corresponding to the middleware
responsible of persisting user's identity after a successful authentication.
This value typically corresponds to a cookie middleware registered in the Startup class.
When omitted, <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/> is used as a fallback value.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.RemoteAuthenticationTimeout">
<summary>
Gets or sets the time limit for completing the authentication flow (15 minutes by default).
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.SaveTokens">
<summary>
Defines whether access and refresh tokens should be stored in the
<see cref="T:Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/> after a successful authorization.
This property is set to <c>false</c> by default to reduce
the size of the final authentication cookie.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.CorrelationCookie">
<summary>
Determines the settings used to create the correlation cookie before the
cookie gets added to the response.
</summary>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.HandleRequestResult">
<summary>
Contains the result of an Authenticate call
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.HandleRequestResult.Handled">
<summary>
Indicates that stage of authentication was directly handled by
user intervention and no further processing should be attempted.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.HandleRequestResult.Skipped">
<summary>
Indicates that the default authentication logic should be
skipped and that the rest of the pipeline should be invoked.
</summary>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.HandleRequestResult.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.HandleRequestResult.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.HandleRequestResult.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="M:Microsoft.AspNetCore.Authentication.HandleRequestResult.Handle">
<summary>
Discontinue all processing for this request and return to the client.
The caller is responsible for generating the full response.
</summary>
<returns>The result.</returns>
</member>
<member name="M:Microsoft.AspNetCore.Authentication.HandleRequestResult.SkipHandler">
<summary>
Discontinue processing the request in the current handler.
</summary>
<returns>The result.</returns>
</member>
<member name="T:Microsoft.AspNetCore.Authentication.SystemClock">
<summary>
Provides access to the normal system clock with precision in seconds.
</summary>
</member>
<member name="P:Microsoft.AspNetCore.Authentication.SystemClock.UtcNow">
<summary>
Retrieves the current system time in UTC.
</summary>
</member>
</members>
</doc>