eef5e6073b1306cd3ed531f1bc4f1cc6e429f9e7
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.AspNetCore.Authentication.Abstractions</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticateResult">\r
8             <summary>\r
9             Contains the result of an Authenticate call\r
10             </summary>\r
11         </member>\r
12         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.#ctor">\r
13             <summary>\r
14             Creates a new <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/> instance.\r
15             </summary>\r
16         </member>\r
17         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Succeeded">\r
18             <summary>\r
19             If a ticket was produced, authenticate was successful.\r
20             </summary>\r
21         </member>\r
22         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Ticket">\r
23             <summary>\r
24             The authentication ticket.\r
25             </summary>\r
26         </member>\r
27         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Principal">\r
28             <summary>\r
29             Gets the claims-principal with authenticated user identities.\r
30             </summary>\r
31         </member>\r
32         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Properties">\r
33             <summary>\r
34             Additional state values for the authentication session.\r
35             </summary>\r
36         </member>\r
37         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Failure">\r
38             <summary>\r
39             Holds failure information from the authentication.\r
40             </summary>\r
41         </member>\r
42         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.None">\r
43             <summary>\r
44             Indicates that there was no information returned for this authentication scheme.\r
45             </summary>\r
46         </member>\r
47         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Clone">\r
48             <summary>\r
49             Create a new deep copy of the result\r
50             </summary>\r
51             <returns>A copy of the result</returns>\r
52         </member>\r
53         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Success(Microsoft.AspNetCore.Authentication.AuthenticationTicket)">\r
54             <summary>\r
55             Indicates that authentication was successful.\r
56             </summary>\r
57             <param name="ticket">The ticket representing the authentication result.</param>\r
58             <returns>The result.</returns>\r
59         </member>\r
60         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.NoResult">\r
61             <summary>\r
62             Indicates that there was no information returned for this authentication scheme.\r
63             </summary>\r
64             <returns>The result.</returns>\r
65         </member>\r
66         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.Exception)">\r
67             <summary>\r
68             Indicates that there was a failure during authentication.\r
69             </summary>\r
70             <param name="failure">The failure exception.</param>\r
71             <returns>The result.</returns>\r
72         </member>\r
73         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.Exception,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
74             <summary>\r
75             Indicates that there was a failure during authentication.\r
76             </summary>\r
77             <param name="failure">The failure exception.</param>\r
78             <param name="properties">Additional state values for the authentication session.</param>\r
79             <returns>The result.</returns>\r
80         </member>\r
81         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.String)">\r
82             <summary>\r
83             Indicates that there was a failure during authentication.\r
84             </summary>\r
85             <param name="failureMessage">The failure message.</param>\r
86             <returns>The result.</returns>\r
87         </member>\r
88         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
89             <summary>\r
90             Indicates that there was a failure during authentication.\r
91             </summary>\r
92             <param name="failureMessage">The failure message.</param>\r
93             <param name="properties">Additional state values for the authentication session.</param>\r
94             <returns>The result.</returns>\r
95         </member>\r
96         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions">\r
97             <summary>\r
98             Extension methods to expose Authentication on HttpContext.\r
99             </summary>\r
100         </member>\r
101         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext)">\r
102             <summary>\r
103             Authenticate the current request using the default authentication scheme.\r
104             The default authentication scheme can be configured using <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/>.\r
105             </summary>\r
106             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
107             <returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/>.</returns>\r
108         </member>\r
109         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">\r
110             <summary>\r
111             Authenticate the current request using the specified scheme.\r
112             </summary>\r
113             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
114             <param name="scheme">The name of the authentication scheme.</param>\r
115             <returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/>.</returns>\r
116         </member>\r
117         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">\r
118             <summary>\r
119             Challenge the current request using the specified scheme.\r
120             An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.\r
121             </summary>\r
122             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
123             <param name="scheme">The name of the authentication scheme.</param>\r
124             <returns>The result.</returns>\r
125         </member>\r
126         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext)">\r
127             <summary>\r
128             Challenge the current request using the default challenge scheme.\r
129             An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.\r
130             The default challenge scheme can be configured using <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/>.\r
131             </summary>\r
132             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
133             <returns>The task.</returns>\r
134         </member>\r
135         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
136             <summary>\r
137             Challenge the current request using the default challenge scheme.\r
138             An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.\r
139             The default challenge scheme can be configured using <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/>.\r
140             </summary>\r
141             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
142             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
143             <returns>The task.</returns>\r
144         </member>\r
145         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
146             <summary>\r
147             Challenge the current request using the specified scheme.\r
148             An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.\r
149             </summary>\r
150             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
151             <param name="scheme">The name of the authentication scheme.</param>\r
152             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
153             <returns>The task.</returns>\r
154         </member>\r
155         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">\r
156             <summary>\r
157             Forbid the current request using the specified scheme.\r
158             Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.\r
159             </summary>\r
160             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
161             <param name="scheme">The name of the authentication scheme.</param>\r
162             <returns>The task.</returns>\r
163         </member>\r
164         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext)">\r
165             <summary>\r
166             Forbid the current request using the default forbid scheme.\r
167             Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.\r
168             The default forbid scheme can be configured using <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.\r
169             </summary>\r
170             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
171             <returns>The task.</returns>\r
172         </member>\r
173         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
174             <summary>\r
175             Forbid the current request using the default forbid scheme.\r
176             Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.\r
177             The default forbid scheme can be configured using <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.\r
178             </summary>\r
179             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
180             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
181             <returns>The task.</returns>\r
182         </member>\r
183         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
184             <summary>\r
185             Forbid the current request using the specified scheme.\r
186             Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.\r
187             </summary>\r
188             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
189             <param name="scheme">The name of the authentication scheme.</param>\r
190             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
191             <returns>The task.</returns>\r
192         </member>\r
193         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal)">\r
194             <summary>\r
195             Sign in a principal for the specified scheme.\r
196             </summary>\r
197             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
198             <param name="scheme">The name of the authentication scheme.</param>\r
199             <param name="principal">The user.</param>\r
200             <returns>The task.</returns>\r
201         </member>\r
202         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.Security.Claims.ClaimsPrincipal)">\r
203             <summary>\r
204             Sign in a principal for the default authentication scheme.\r
205             The default scheme for signing in can be configured using <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.\r
206             </summary>\r
207             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
208             <param name="principal">The user.</param>\r
209             <returns>The task.</returns>\r
210         </member>\r
211         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
212             <summary>\r
213             Sign in a principal for the default authentication scheme.\r
214             The default scheme for signing in can be configured using <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.\r
215             </summary>\r
216             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
217             <param name="principal">The user.</param>\r
218             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
219             <returns>The task.</returns>\r
220         </member>\r
221         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
222             <summary>\r
223             Sign in a principal for the specified scheme.\r
224             </summary>\r
225             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
226             <param name="scheme">The name of the authentication scheme.</param>\r
227             <param name="principal">The user.</param>\r
228             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
229             <returns>The task.</returns>\r
230         </member>\r
231         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext)">\r
232             <summary>\r
233             Sign out a principal for the default authentication scheme.\r
234             The default scheme for signing out can be configured using <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.\r
235             </summary>\r
236             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
237             <returns>The task.</returns>\r
238         </member>\r
239         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
240             <summary>\r
241             Sign out a principal for the default authentication scheme.\r
242             The default scheme for signing out can be configured using <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.\r
243             </summary>\r
244             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
245             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
246             <returns>The task.</returns>\r
247         </member>\r
248         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">\r
249             <summary>\r
250             Sign out a principal for the specified scheme.\r
251             </summary>\r
252             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
253             <param name="scheme">The name of the authentication scheme.</param>\r
254             <returns>The task.</returns>\r
255         </member>\r
256         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
257             <summary>\r
258             Sign out a principal for the specified scheme.\r
259             </summary>\r
260             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
261             <param name="scheme">The name of the authentication scheme.</param>\r
262             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
263             <returns>The task.</returns>\r
264         </member>\r
265         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.GetTokenAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.String)">\r
266             <summary>\r
267             Authenticates the request using the specified scheme and returns the value for the token.\r
268             </summary>\r
269             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
270             <param name="scheme">The name of the authentication scheme.</param>\r
271             <param name="tokenName">The name of the token.</param>\r
272             <returns>The value of the token if present.</returns>\r
273         </member>\r
274         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.GetTokenAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">\r
275             <summary>\r
276             Authenticates the request using the default authentication scheme and returns the value for the token.\r
277             The default authentication scheme can be configured using <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/>.\r
278             </summary>\r
279             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
280             <param name="tokenName">The name of the token.</param>\r
281             <returns>The value of the token if present.</returns>\r
282         </member>\r
283         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions">\r
284             <summary>\r
285             Options to configure authentication.\r
286             </summary>\r
287         </member>\r
288         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.Schemes">\r
289             <summary>\r
290             Returns the schemes in the order they were added (important for request handling priority)\r
291             </summary>\r
292         </member>\r
293         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.SchemeMap">\r
294             <summary>\r
295             Maps schemes by name.\r
296             </summary>\r
297         </member>\r
298         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationOptions.AddScheme(System.String,System.Action{Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder})">\r
299             <summary>\r
300             Adds an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>.\r
301             </summary>\r
302             <param name="name">The name of the scheme being added.</param>\r
303             <param name="configureBuilder">Configures the scheme.</param>\r
304         </member>\r
305         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationOptions.AddScheme``1(System.String,System.String)">\r
306             <summary>\r
307             Adds an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>.\r
308             </summary>\r
309             <typeparam name="THandler">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> responsible for the scheme.</typeparam>\r
310             <param name="name">The name of the scheme being added.</param>\r
311             <param name="displayName">The display name for the scheme.</param>\r
312         </member>\r
313         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme">\r
314             <summary>\r
315             Used as the fallback default scheme for all the other defaults.\r
316             </summary>\r
317         </member>\r
318         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme">\r
319             <summary>\r
320             Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.\r
321             </summary>\r
322         </member>\r
323         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme">\r
324             <summary>\r
325             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)"/>.\r
326             </summary>\r
327         </member>\r
328         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme">\r
329             <summary>\r
330             Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.\r
331             </summary>\r
332         </member>\r
333         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme">\r
334             <summary>\r
335             Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.\r
336             </summary>\r
337         </member>\r
338         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme">\r
339             <summary>\r
340             Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.\r
341             </summary>\r
342         </member>\r
343         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.RequireAuthenticatedSignIn">\r
344             <summary>\r
345             If true, SignIn should throw if attempted with a user is not authenticated.\r
346             A user is considered authenticated if <see cref="P:System.Security.Claims.ClaimsIdentity.IsAuthenticated"/> returns <see langword="true" /> for the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> associated with the HTTP request.\r
347             </summary>\r
348         </member>\r
349         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties">\r
350             <summary>\r
351             Dictionary used to store state values about the authentication session.\r
352             </summary>\r
353         </member>\r
354         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.#ctor">\r
355             <summary>\r
356             Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class.\r
357             </summary>\r
358         </member>\r
359         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.#ctor(System.Collections.Generic.IDictionary{System.String,System.String})">\r
360             <summary>\r
361             Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class.\r
362             </summary>\r
363             <param name="items">State values dictionary to use.</param>\r
364         </member>\r
365         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Object})">\r
366             <summary>\r
367             Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class.\r
368             </summary>\r
369             <param name="items">State values dictionary to use.</param>\r
370             <param name="parameters">Parameters dictionary to use.</param>\r
371         </member>\r
372         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Clone">\r
373             <summary>\r
374             Return a copy.\r
375             </summary>\r
376             <returns>A copy.</returns>\r
377         </member>\r
378         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items">\r
379             <summary>\r
380             State values about the authentication session.\r
381             </summary>\r
382         </member>\r
383         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Parameters">\r
384             <summary>\r
385             Collection of parameters that are passed to the authentication handler. These are not intended for\r
386             serialization or persistence, only for flowing data between call sites.\r
387             </summary>\r
388         </member>\r
389         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.IsPersistent">\r
390             <summary>\r
391             Gets or sets whether the authentication session is persisted across multiple requests.\r
392             </summary>\r
393         </member>\r
394         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.RedirectUri">\r
395             <summary>\r
396             Gets or sets the full path or absolute URI to be used as an http redirect response value.\r
397             </summary>\r
398         </member>\r
399         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.IssuedUtc">\r
400             <summary>\r
401             Gets or sets the time at which the authentication ticket was issued.\r
402             </summary>\r
403         </member>\r
404         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.ExpiresUtc">\r
405             <summary>\r
406             Gets or sets the time at which the authentication ticket expires.\r
407             </summary>\r
408         </member>\r
409         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.AllowRefresh">\r
410             <summary>\r
411             Gets or sets if refreshing the authentication session should be allowed.\r
412             </summary>\r
413         </member>\r
414         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetString(System.String)">\r
415             <summary>\r
416             Get a string value from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.\r
417             </summary>\r
418             <param name="key">Property key.</param>\r
419             <returns>Retrieved value or <c>null</c> if the property is not set.</returns>\r
420         </member>\r
421         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetString(System.String,System.String)">\r
422             <summary>\r
423             Set or remove a string value from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.\r
424             </summary>\r
425             <param name="key">Property key.</param>\r
426             <param name="value">Value to set or <see langword="null" /> to remove the property.</param>\r
427         </member>\r
428         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetParameter``1(System.String)">\r
429             <summary>\r
430             Get a parameter from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Parameters"/> collection.\r
431             </summary>\r
432             <typeparam name="T">Parameter type.</typeparam>\r
433             <param name="key">Parameter key.</param>\r
434             <returns>Retrieved value or the default value if the property is not set.</returns>\r
435         </member>\r
436         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetParameter``1(System.String,``0)">\r
437             <summary>\r
438             Set a parameter value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Parameters"/> collection.\r
439             </summary>\r
440             <typeparam name="T">Parameter type.</typeparam>\r
441             <param name="key">Parameter key.</param>\r
442             <param name="value">Value to set.</param>\r
443         </member>\r
444         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetBool(System.String)">\r
445             <summary>\r
446             Get a nullable <see cref="T:System.Boolean"/> from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.\r
447             </summary>\r
448             <param name="key">Property key.</param>\r
449             <returns>Retrieved value or <see langword="null" /> if the property is not set.</returns>\r
450         </member>\r
451         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetBool(System.String,System.Nullable{System.Boolean})">\r
452             <summary>\r
453             Set or remove a <see cref="T:System.Boolean"/> value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.\r
454             </summary>\r
455             <param name="key">Property key.</param>\r
456             <param name="value">Value to set or <see langword="null" /> to remove the property.</param>\r
457         </member>\r
458         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetDateTimeOffset(System.String)">\r
459             <summary>\r
460             Get a nullable <see cref="T:System.DateTimeOffset"/> value from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.\r
461             </summary>\r
462             <param name="key">Property key.</param>\r
463             <returns>Retrieved value or <see langword="null" /> if the property is not set.</returns>\r
464         </member>\r
465         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetDateTimeOffset(System.String,System.Nullable{System.DateTimeOffset})">\r
466             <summary>\r
467             Sets or removes a <see cref="T:System.DateTimeOffset" /> value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.\r
468             </summary>\r
469             <param name="key">Property key.</param>\r
470             <param name="value">Value to set or <see langword="null" /> to remove the property.</param>\r
471         </member>\r
472         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme">\r
473             <summary>\r
474             AuthenticationSchemes assign a name to a specific <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/>\r
475             handlerType.\r
476             </summary>\r
477         </member>\r
478         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationScheme.#ctor(System.String,System.String,System.Type)">\r
479             <summary>\r
480             Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>.\r
481             </summary>\r
482             <param name="name">The name for the authentication scheme.</param>\r
483             <param name="displayName">The display name for the authentication scheme.</param>\r
484             <param name="handlerType">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type that handles this scheme.</param>\r
485         </member>\r
486         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.Name">\r
487             <summary>\r
488             The name of the authentication scheme.\r
489             </summary>\r
490         </member>\r
491         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.DisplayName">\r
492             <summary>\r
493             The display name for the scheme. Null is valid and used for non user facing schemes.\r
494             </summary>\r
495         </member>\r
496         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.HandlerType">\r
497             <summary>\r
498             The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type that handles this scheme.\r
499             </summary>\r
500         </member>\r
501         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder">\r
502             <summary>\r
503             Used to build <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.\r
504             </summary>\r
505         </member>\r
506         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.#ctor(System.String)">\r
507             <summary>\r
508             Constructor.\r
509             </summary>\r
510             <param name="name">The name of the scheme being built.</param>\r
511         </member>\r
512         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.Name">\r
513             <summary>\r
514             Gets the name of the scheme being built.\r
515             </summary>\r
516         </member>\r
517         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.DisplayName">\r
518             <summary>\r
519             Gets or sets the display name for the scheme being built.\r
520             </summary>\r
521         </member>\r
522         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.HandlerType">\r
523             <summary>\r
524             Gets or sets the <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type responsible for this scheme.\r
525             </summary>\r
526         </member>\r
527         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.Build">\r
528             <summary>\r
529             Builds the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> instance.\r
530             </summary>\r
531             <returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>.</returns>\r
532         </member>\r
533         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket">\r
534             <summary>\r
535             Contains user identity information as well as additional authentication state.\r
536             </summary>\r
537         </member>\r
538         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTicket.#ctor(System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.String)">\r
539             <summary>\r
540             Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket"/> class\r
541             </summary>\r
542             <param name="principal">the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> that represents the authenticated user.</param>\r
543             <param name="properties">additional properties that can be consumed by the user or runtime.</param>\r
544             <param name="authenticationScheme">the authentication scheme that was responsible for this ticket.</param>\r
545         </member>\r
546         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTicket.#ctor(System.Security.Claims.ClaimsPrincipal,System.String)">\r
547             <summary>\r
548             Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket"/> class\r
549             </summary>\r
550             <param name="principal">the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> that represents the authenticated user.</param>\r
551             <param name="authenticationScheme">the authentication scheme that was responsible for this ticket.</param>\r
552         </member>\r
553         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.AuthenticationScheme">\r
554             <summary>\r
555             Gets the authentication scheme that was responsible for this ticket.\r
556             </summary>\r
557         </member>\r
558         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.Principal">\r
559             <summary>\r
560             Gets the claims-principal with authenticated user identities.\r
561             </summary>\r
562         </member>\r
563         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.Properties">\r
564             <summary>\r
565             Additional state values for the authentication session.\r
566             </summary>\r
567         </member>\r
568         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTicket.Clone">\r
569             <summary>\r
570             Returns a copy of the ticket.\r
571             </summary>\r
572             <remarks>\r
573             The method clones the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.Principal"/> by calling <see cref="M:System.Security.Claims.ClaimsIdentity.Clone"/> on each of the <see cref="P:System.Security.Claims.ClaimsPrincipal.Identities"/>.\r
574             </remarks>\r
575             <returns>A copy of the ticket</returns>\r
576         </member>\r
577         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationToken">\r
578             <summary>\r
579             Name/Value representing a token.\r
580             </summary>\r
581         </member>\r
582         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationToken.Name">\r
583             <summary>\r
584             Name.\r
585             </summary>\r
586         </member>\r
587         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationToken.Value">\r
588             <summary>\r
589             Value.\r
590             </summary>\r
591         </member>\r
592         <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticateResultFeature">\r
593             <summary>\r
594             Used to capture the <see cref="P:Microsoft.AspNetCore.Authentication.IAuthenticateResultFeature.AuthenticateResult"/> from the authorization middleware.\r
595             </summary>\r
596         </member>\r
597         <member name="P:Microsoft.AspNetCore.Authentication.IAuthenticateResultFeature.AuthenticateResult">\r
598             <summary>\r
599             The <see cref="P:Microsoft.AspNetCore.Authentication.IAuthenticateResultFeature.AuthenticateResult"/> from the authorization middleware.\r
600             Set to null if the <see cref="P:Microsoft.AspNetCore.Http.Features.Authentication.IHttpAuthenticationFeature.User"/> property is set after the authorization middleware.\r
601             </summary>\r
602         </member>\r
603         <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationFeature">\r
604             <summary>\r
605             Used to capture path info so redirects can be computed properly within an app.Map().\r
606             </summary>\r
607         </member>\r
608         <member name="P:Microsoft.AspNetCore.Authentication.IAuthenticationFeature.OriginalPathBase">\r
609             <summary>\r
610             The original path base.\r
611             </summary>\r
612         </member>\r
613         <member name="P:Microsoft.AspNetCore.Authentication.IAuthenticationFeature.OriginalPath">\r
614             <summary>\r
615             The original path.\r
616             </summary>\r
617         </member>\r
618         <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler">\r
619             <summary>\r
620             Created per request to handle authentication for a particular scheme.\r
621             </summary>\r
622         </member>\r
623         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.InitializeAsync(Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Http.HttpContext)">\r
624             <summary>\r
625             Initialize the authentication handler. The handler should initialize anything it needs from the request and scheme as part of this method.\r
626             </summary>\r
627             <param name="scheme">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> scheme.</param>\r
628             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
629         </member>\r
630         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.AuthenticateAsync">\r
631             <summary>\r
632             Authenticate the current request.\r
633             </summary>\r
634             <returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/> result.</returns>\r
635         </member>\r
636         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.ChallengeAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
637             <summary>\r
638             Challenge the current request.\r
639             </summary>\r
640             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>\r
641         </member>\r
642         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.ForbidAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
643             <summary>\r
644             Forbid the current request.\r
645             </summary>\r
646             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>\r
647         </member>\r
648         <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider">\r
649             <summary>\r
650             Provides the appropriate IAuthenticationHandler instance for the authenticationScheme and request.\r
651             </summary>\r
652         </member>\r
653         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider.GetHandlerAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">\r
654             <summary>\r
655             Returns the handler instance that will be used.\r
656             </summary>\r
657             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>\r
658             <param name="authenticationScheme">The name of the authentication scheme being handled.</param>\r
659             <returns>The handler instance.</returns>\r
660         </member>\r
661         <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler">\r
662             <summary>\r
663             Used to determine if a handler wants to participate in request processing.\r
664             </summary>\r
665         </member>\r
666         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler.HandleRequestAsync">\r
667             <summary>\r
668             Gets a value that determines if the request should stop being processed.\r
669             <para>\r
670             This feature is supported by the Authentication middleware\r
671             which does not invoke any subsequent <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> or middleware configured in the request pipeline\r
672             if the handler returns <see langword="true" />.\r
673             </para>\r
674             </summary>\r
675             <returns><see langword="true" /> if request processing should stop.</returns>\r
676         </member>\r
677         <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider">\r
678             <summary>\r
679             Responsible for managing what authenticationSchemes are supported.\r
680             </summary>\r
681         </member>\r
682         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetAllSchemesAsync">\r
683             <summary>\r
684             Returns all currently registered <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.\r
685             </summary>\r
686             <returns>All currently registered <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.</returns>\r
687         </member>\r
688         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetSchemeAsync(System.String)">\r
689             <summary>\r
690             Returns the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> matching the name, or null.\r
691             </summary>\r
692             <param name="name">The name of the authenticationScheme.</param>\r
693             <returns>The scheme or null if not found.</returns>\r
694         </member>\r
695         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultAuthenticateSchemeAsync">\r
696             <summary>\r
697             Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.\r
698             This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/>.\r
699             Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.\r
700             </summary>\r
701             <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>\r
702         </member>\r
703         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync">\r
704             <summary>\r
705             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)"/>.\r
706             This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/>.\r
707             Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.\r
708             </summary>\r
709             <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>\r
710         </member>\r
711         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultForbidSchemeAsync">\r
712             <summary>\r
713             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)"/>.\r
714             This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.\r
715             Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync"/> .\r
716             </summary>\r
717             <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>\r
718         </member>\r
719         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignInSchemeAsync">\r
720             <summary>\r
721             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)"/>.\r
722             This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.\r
723             Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.\r
724             </summary>\r
725             <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>\r
726         </member>\r
727         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignOutSchemeAsync">\r
728             <summary>\r
729             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)"/>.\r
730             This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.\r
731             Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignInSchemeAsync"/> .\r
732             </summary>\r
733             <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>\r
734         </member>\r
735         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.AddScheme(Microsoft.AspNetCore.Authentication.AuthenticationScheme)">\r
736             <summary>\r
737             Registers a scheme for use by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.\r
738             </summary>\r
739             <param name="scheme">The scheme.</param>\r
740         </member>\r
741         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.TryAddScheme(Microsoft.AspNetCore.Authentication.AuthenticationScheme)">\r
742             <summary>\r
743             Registers a scheme for use by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.\r
744             </summary>\r
745             <param name="scheme">The scheme.</param>\r
746             <returns>true if the scheme was added successfully.</returns>\r
747         </member>\r
748         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.RemoveScheme(System.String)">\r
749             <summary>\r
750             Removes a scheme, preventing it from being used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.\r
751             </summary>\r
752             <param name="name">The name of the authenticationScheme being removed.</param>\r
753         </member>\r
754         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetRequestHandlerSchemesAsync">\r
755             <summary>\r
756             Returns the schemes in priority order for request handling.\r
757             </summary>\r
758             <returns>The schemes in priority order for request handling</returns>\r
759         </member>\r
760         <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationService">\r
761             <summary>\r
762             Used to provide authentication.\r
763             </summary>\r
764         </member>\r
765         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">\r
766             <summary>\r
767             Authenticate for the specified authentication scheme.\r
768             </summary>\r
769             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>\r
770             <param name="scheme">The name of the authentication scheme.</param>\r
771             <returns>The result.</returns>\r
772         </member>\r
773         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
774             <summary>\r
775             Challenge the specified authentication scheme.\r
776             An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.\r
777             </summary>\r
778             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>\r
779             <param name="scheme">The name of the authentication scheme.</param>\r
780             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>\r
781             <returns>A task.</returns>\r
782         </member>\r
783         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
784             <summary>\r
785             Forbids the specified authentication scheme.\r
786             Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.\r
787             </summary>\r
788             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>\r
789             <param name="scheme">The name of the authentication scheme.</param>\r
790             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>\r
791             <returns>A task.</returns>\r
792         </member>\r
793         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
794             <summary>\r
795             Sign a principal in for the specified authentication scheme.\r
796             </summary>\r
797             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>\r
798             <param name="scheme">The name of the authentication scheme.</param>\r
799             <param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to sign in.</param>\r
800             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>\r
801             <returns>A task.</returns>\r
802         </member>\r
803         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
804             <summary>\r
805             Sign out the specified authentication scheme.\r
806             </summary>\r
807             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>\r
808             <param name="scheme">The name of the authentication scheme.</param>\r
809             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>\r
810             <returns>A task.</returns>\r
811         </member>\r
812         <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler">\r
813             <summary>\r
814             Used to determine if a handler supports SignIn.\r
815             </summary>\r
816         </member>\r
817         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler.SignInAsync(System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
818             <summary>\r
819             Handle sign in.\r
820             </summary>\r
821             <param name="user">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> user.</param>\r
822             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>\r
823             <returns>A task.</returns>\r
824         </member>\r
825         <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler">\r
826             <summary>\r
827             Used to determine if a handler supports SignOut.\r
828             </summary>\r
829         </member>\r
830         <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler.SignOutAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
831             <summary>\r
832             Signout behavior.\r
833             </summary>\r
834             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>\r
835             <returns>A task.</returns>\r
836         </member>\r
837         <member name="T:Microsoft.AspNetCore.Authentication.IClaimsTransformation">\r
838             <summary>\r
839             Used by the <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/> for claims transformation.\r
840             </summary>\r
841         </member>\r
842         <member name="M:Microsoft.AspNetCore.Authentication.IClaimsTransformation.TransformAsync(System.Security.Claims.ClaimsPrincipal)">\r
843             <summary>\r
844             Provides a central transformation point to change the specified principal.\r
845             Note: this will be run on each AuthenticateAsync call, so its safer to\r
846             return a new ClaimsPrincipal if your transformation is not idempotent.\r
847             </summary>\r
848             <param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to transform.</param>\r
849             <returns>The transformed principal.</returns>\r
850         </member>\r
851         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions">\r
852             <summary>\r
853             Extension methods for storing authentication tokens in <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.\r
854             </summary>\r
855         </member>\r
856         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.StoreTokens(Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authentication.AuthenticationToken})">\r
857             <summary>\r
858             Stores a set of authentication tokens, after removing any old tokens.\r
859             </summary>\r
860             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
861             <param name="tokens">The tokens to store.</param>\r
862         </member>\r
863         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenValue(Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.String)">\r
864             <summary>\r
865             Returns the value of a token.\r
866             </summary>\r
867             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
868             <param name="tokenName">The token name.</param>\r
869             <returns>The token value.</returns>\r
870         </member>\r
871         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.UpdateTokenValue(Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.String,System.String)">\r
872             <summary>\r
873             Updates the value of a token if already present.\r
874             </summary>\r
875             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> to update.</param>\r
876             <param name="tokenName">The token name.</param>\r
877             <param name="tokenValue">The token value.</param>\r
878             <returns><see langword="true"/> if the token was updated, otherwise <see langword="false"/>.</returns>\r
879         </member>\r
880         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokens(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">\r
881             <summary>\r
882             Returns all of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationToken"/> instances contained in the properties.\r
883             </summary>\r
884             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>\r
885             <returns>The authentication tokens.</returns>\r
886         </member>\r
887         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenAsync(Microsoft.AspNetCore.Authentication.IAuthenticationService,Microsoft.AspNetCore.Http.HttpContext,System.String)">\r
888             <summary>\r
889             Authenticates the request using the specified authentication scheme and returns the value for the token.\r
890             </summary>\r
891             <param name="auth">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.</param>\r
892             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
893             <param name="tokenName">The name of the token.</param>\r
894             <returns>The value of the token if present.</returns>\r
895         </member>\r
896         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenAsync(Microsoft.AspNetCore.Authentication.IAuthenticationService,Microsoft.AspNetCore.Http.HttpContext,System.String,System.String)">\r
897             <summary>\r
898             Authenticates the request using the specified authentication scheme and returns the value for the token.\r
899             </summary>\r
900             <param name="auth">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.</param>\r
901             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>\r
902             <param name="scheme">The name of the authentication scheme.</param>\r
903             <param name="tokenName">The name of the token.</param>\r
904             <returns>The value of the token if present.</returns>\r
905         </member>\r
906     </members>\r
907 </doc>\r