1 <?xml version="1.0"?>
\r
4 <name>Microsoft.AspNetCore.Authentication.Abstractions</name>
\r
7 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticateResult">
\r
9 Contains the result of an Authenticate call
\r
12 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.#ctor">
\r
14 Creates a new <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/> instance.
\r
17 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Succeeded">
\r
19 If a ticket was produced, authenticate was successful.
\r
22 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Ticket">
\r
24 The authentication ticket.
\r
27 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Principal">
\r
29 Gets the claims-principal with authenticated user identities.
\r
32 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Properties">
\r
34 Additional state values for the authentication session.
\r
37 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Failure">
\r
39 Holds failure information from the authentication.
\r
42 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.None">
\r
44 Indicates that there was no information returned for this authentication scheme.
\r
47 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Success(Microsoft.AspNetCore.Authentication.AuthenticationTicket)">
\r
49 Indicates that authentication was successful.
\r
51 <param name="ticket">The ticket representing the authentication result.</param>
\r
52 <returns>The result.</returns>
\r
54 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.NoResult">
\r
56 Indicates that there was no information returned for this authentication scheme.
\r
58 <returns>The result.</returns>
\r
60 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.Exception)">
\r
62 Indicates that there was a failure during authentication.
\r
64 <param name="failure">The failure exception.</param>
\r
65 <returns>The result.</returns>
\r
67 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.Exception,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
69 Indicates that there was a failure during authentication.
\r
71 <param name="failure">The failure exception.</param>
\r
72 <param name="properties">Additional state values for the authentication session.</param>
\r
73 <returns>The result.</returns>
\r
75 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.String)">
\r
77 Indicates that there was a failure during authentication.
\r
79 <param name="failureMessage">The failure message.</param>
\r
80 <returns>The result.</returns>
\r
82 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
84 Indicates that there was a failure during authentication.
\r
86 <param name="failureMessage">The failure message.</param>
\r
87 <param name="properties">Additional state values for the authentication session.</param>
\r
88 <returns>The result.</returns>
\r
90 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions">
\r
92 Extension methods to expose Authentication on HttpContext.
\r
95 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext)">
\r
97 Extension method for authenticate using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/> scheme.
\r
99 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
100 <returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/>.</returns>
\r
102 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
\r
104 Extension method for authenticate.
\r
106 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
107 <param name="scheme">The name of the authentication scheme.</param>
\r
108 <returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/>.</returns>
\r
110 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
\r
112 Extension method for Challenge.
\r
114 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
115 <param name="scheme">The name of the authentication scheme.</param>
\r
116 <returns>The result.</returns>
\r
118 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext)">
\r
120 Extension method for authenticate using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/> scheme.
\r
122 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
123 <returns>The task.</returns>
\r
125 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
127 Extension method for authenticate using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/> scheme.
\r
129 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
130 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
131 <returns>The task.</returns>
\r
133 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
135 Extension method for Challenge.
\r
137 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
138 <param name="scheme">The name of the authentication scheme.</param>
\r
139 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
140 <returns>The task.</returns>
\r
142 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
\r
144 Extension method for Forbid.
\r
146 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
147 <param name="scheme">The name of the authentication scheme.</param>
\r
148 <returns>The task.</returns>
\r
150 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext)">
\r
152 Extension method for Forbid using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/> scheme..
\r
154 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
155 <returns>The task.</returns>
\r
157 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
159 Extension method for Forbid.
\r
161 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
162 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
163 <returns>The task.</returns>
\r
165 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
167 Extension method for Forbid.
\r
169 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
170 <param name="scheme">The name of the authentication scheme.</param>
\r
171 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
172 <returns>The task.</returns>
\r
174 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal)">
\r
176 Extension method for SignIn.
\r
178 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
179 <param name="scheme">The name of the authentication scheme.</param>
\r
180 <param name="principal">The user.</param>
\r
181 <returns>The task.</returns>
\r
183 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.Security.Claims.ClaimsPrincipal)">
\r
185 Extension method for SignIn using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
\r
187 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
188 <param name="principal">The user.</param>
\r
189 <returns>The task.</returns>
\r
191 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
193 Extension method for SignIn using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
\r
195 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
196 <param name="principal">The user.</param>
\r
197 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
198 <returns>The task.</returns>
\r
200 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
202 Extension method for SignIn.
\r
204 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
205 <param name="scheme">The name of the authentication scheme.</param>
\r
206 <param name="principal">The user.</param>
\r
207 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
208 <returns>The task.</returns>
\r
210 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext)">
\r
212 Extension method for SignOut using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
\r
214 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
215 <returns>The task.</returns>
\r
217 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
219 Extension method for SignOut using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
\r
221 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
222 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
223 <returns>The task.</returns>
\r
225 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
\r
227 Extension method for SignOut.
\r
229 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
230 <param name="scheme">The name of the authentication scheme.</param>
\r
231 <returns>The task.</returns>
\r
233 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
235 Extension method for SignOut.
\r
237 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
238 <param name="scheme">The name of the authentication scheme.</param>
\r
239 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
240 <returns>The task.</returns>
\r
242 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.GetTokenAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.String)">
\r
244 Extension method for getting the value of an authentication token.
\r
246 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
247 <param name="scheme">The name of the authentication scheme.</param>
\r
248 <param name="tokenName">The name of the token.</param>
\r
249 <returns>The value of the token.</returns>
\r
251 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.GetTokenAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
\r
253 Extension method for getting the value of an authentication token.
\r
255 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
256 <param name="tokenName">The name of the token.</param>
\r
257 <returns>The value of the token.</returns>
\r
259 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.Schemes">
\r
261 Returns the schemes in the order they were added (important for request handling priority)
\r
264 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.SchemeMap">
\r
266 Maps schemes by name.
\r
269 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationOptions.AddScheme(System.String,System.Action{Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder})">
\r
271 Adds an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>.
\r
273 <param name="name">The name of the scheme being added.</param>
\r
274 <param name="configureBuilder">Configures the scheme.</param>
\r
276 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationOptions.AddScheme``1(System.String,System.String)">
\r
278 Adds an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>.
\r
280 <typeparam name="THandler">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> responsible for the scheme.</typeparam>
\r
281 <param name="name">The name of the scheme being added.</param>
\r
282 <param name="displayName">The display name for the scheme.</param>
\r
284 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme">
\r
286 Used as the fallback default scheme for all the other defaults.
\r
289 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme">
\r
291 Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.
\r
294 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme">
\r
296 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
299 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme">
\r
301 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
304 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme">
\r
306 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
309 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme">
\r
311 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
314 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.RequireAuthenticatedSignIn">
\r
316 If true, SignIn should throw if attempted with a ClaimsPrincipal.Identity.IsAuthenticated = false.
\r
319 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties">
\r
321 Dictionary used to store state values about the authentication session.
\r
324 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.#ctor">
\r
326 Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class.
\r
329 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.#ctor(System.Collections.Generic.IDictionary{System.String,System.String})">
\r
331 Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class.
\r
333 <param name="items">State values dictionary to use.</param>
\r
335 <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
337 Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class.
\r
339 <param name="items">State values dictionary to use.</param>
\r
340 <param name="parameters">Parameters dictionary to use.</param>
\r
342 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items">
\r
344 State values about the authentication session.
\r
347 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Parameters">
\r
349 Collection of parameters that are passed to the authentication handler. These are not intended for
\r
350 serialization or persistence, only for flowing data between call sites.
\r
353 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.IsPersistent">
\r
355 Gets or sets whether the authentication session is persisted across multiple requests.
\r
358 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.RedirectUri">
\r
360 Gets or sets the full path or absolute URI to be used as an http redirect response value.
\r
363 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.IssuedUtc">
\r
365 Gets or sets the time at which the authentication ticket was issued.
\r
368 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.ExpiresUtc">
\r
370 Gets or sets the time at which the authentication ticket expires.
\r
373 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.AllowRefresh">
\r
375 Gets or sets if refreshing the authentication session should be allowed.
\r
378 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetString(System.String)">
\r
380 Get a string value from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
\r
382 <param name="key">Property key.</param>
\r
383 <returns>Retrieved value or <c>null</c> if the property is not set.</returns>
\r
385 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetString(System.String,System.String)">
\r
387 Set a string value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
\r
389 <param name="key">Property key.</param>
\r
390 <param name="value">Value to set or <c>null</c> to remove the property.</param>
\r
392 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetParameter``1(System.String)">
\r
394 Get a parameter from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Parameters"/> collection.
\r
396 <typeparam name="T">Parameter type.</typeparam>
\r
397 <param name="key">Parameter key.</param>
\r
398 <returns>Retrieved value or the default value if the property is not set.</returns>
\r
400 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetParameter``1(System.String,``0)">
\r
402 Set a parameter value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Parameters"/> collection.
\r
404 <typeparam name="T">Parameter type.</typeparam>
\r
405 <param name="key">Parameter key.</param>
\r
406 <param name="value">Value to set.</param>
\r
408 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetBool(System.String)">
\r
410 Get a bool value from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
\r
412 <param name="key">Property key.</param>
\r
413 <returns>Retrieved value or <c>null</c> if the property is not set.</returns>
\r
415 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetBool(System.String,System.Nullable{System.Boolean})">
\r
417 Set a bool value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
\r
419 <param name="key">Property key.</param>
\r
420 <param name="value">Value to set or <c>null</c> to remove the property.</param>
\r
422 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetDateTimeOffset(System.String)">
\r
424 Get a DateTimeOffset value from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
\r
426 <param name="key">Property key.</param>
\r
427 <returns>Retrieved value or <c>null</c> if the property is not set.</returns>
\r
429 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetDateTimeOffset(System.String,System.Nullable{System.DateTimeOffset})">
\r
431 Set a DateTimeOffset value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
\r
433 <param name="key">Property key.</param>
\r
434 <param name="value">Value to set or <c>null</c> to remove the property.</param>
\r
436 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme">
\r
438 AuthenticationSchemes assign a name to a specific <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/>
\r
442 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationScheme.#ctor(System.String,System.String,System.Type)">
\r
446 <param name="name">The name for the authentication scheme.</param>
\r
447 <param name="displayName">The display name for the authentication scheme.</param>
\r
448 <param name="handlerType">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type that handles this scheme.</param>
\r
450 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.Name">
\r
452 The name of the authentication scheme.
\r
455 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.DisplayName">
\r
457 The display name for the scheme. Null is valid and used for non user facing schemes.
\r
460 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.HandlerType">
\r
462 The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type that handles this scheme.
\r
465 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder">
\r
467 Used to build <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.
\r
470 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.#ctor(System.String)">
\r
474 <param name="name">The name of the scheme being built.</param>
\r
476 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.Name">
\r
478 The name of the scheme being built.
\r
481 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.DisplayName">
\r
483 The display name for the scheme being built.
\r
486 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.HandlerType">
\r
488 The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type responsible for this scheme.
\r
491 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.Build">
\r
493 Builds the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> instance.
\r
495 <returns></returns>
\r
497 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket">
\r
499 Contains user identity information as well as additional authentication state.
\r
502 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTicket.#ctor(System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.String)">
\r
504 Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket"/> class
\r
506 <param name="principal">the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> that represents the authenticated user.</param>
\r
507 <param name="properties">additional properties that can be consumed by the user or runtime.</param>
\r
508 <param name="authenticationScheme">the authentication middleware that was responsible for this ticket.</param>
\r
510 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTicket.#ctor(System.Security.Claims.ClaimsPrincipal,System.String)">
\r
512 Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket"/> class
\r
514 <param name="principal">the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> that represents the authenticated user.</param>
\r
515 <param name="authenticationScheme">the authentication middleware that was responsible for this ticket.</param>
\r
517 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.AuthenticationScheme">
\r
519 Gets the authentication type.
\r
522 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.Principal">
\r
524 Gets the claims-principal with authenticated user identities.
\r
527 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.Properties">
\r
529 Additional state values for the authentication session.
\r
532 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationToken">
\r
534 Name/Value representing a token.
\r
537 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationToken.Name">
\r
542 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationToken.Value">
\r
547 <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationFeature">
\r
549 Used to capture path info so redirects can be computed properly within an app.Map().
\r
552 <member name="P:Microsoft.AspNetCore.Authentication.IAuthenticationFeature.OriginalPathBase">
\r
554 The original path base.
\r
557 <member name="P:Microsoft.AspNetCore.Authentication.IAuthenticationFeature.OriginalPath">
\r
562 <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler">
\r
564 Created per request to handle authentication for to a particular scheme.
\r
567 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.InitializeAsync(Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Http.HttpContext)">
\r
569 The handler should initialize anything it needs from the request and scheme here.
\r
571 <param name="scheme">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> scheme.</param>
\r
572 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
573 <returns></returns>
\r
575 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.AuthenticateAsync">
\r
577 Authentication behavior.
\r
579 <returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/> result.</returns>
\r
581 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.ChallengeAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
583 Challenge behavior.
\r
585 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
\r
586 <returns>A task.</returns>
\r
588 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.ForbidAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
592 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
\r
593 <returns>A task.</returns>
\r
595 <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider">
\r
597 Provides the appropriate IAuthenticationHandler instance for the authenticationScheme and request.
\r
600 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider.GetHandlerAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
\r
602 Returns the handler instance that will be used.
\r
604 <param name="context">The context.</param>
\r
605 <param name="authenticationScheme">The name of the authentication scheme being handled.</param>
\r
606 <returns>The handler instance.</returns>
\r
608 <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler">
\r
610 Used to determine if a handler wants to participate in request processing.
\r
613 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler.HandleRequestAsync">
\r
615 Returns true if request processing should stop.
\r
617 <returns><code>true</code> if request processing should stop.</returns>
\r
619 <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider">
\r
621 Responsible for managing what authenticationSchemes are supported.
\r
624 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetAllSchemesAsync">
\r
626 Returns all currently registered <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.
\r
628 <returns>All currently registered <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.</returns>
\r
630 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetSchemeAsync(System.String)">
\r
632 Returns the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> matching the name, or null.
\r
634 <param name="name">The name of the authenticationScheme.</param>
\r
635 <returns>The scheme or null if not found.</returns>
\r
637 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultAuthenticateSchemeAsync">
\r
639 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
640 This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/>.
\r
641 Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
\r
643 <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
645 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync">
\r
647 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
648 This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/>.
\r
649 Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
\r
651 <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
653 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultForbidSchemeAsync">
\r
655 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
656 This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.
\r
657 Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync"/> .
\r
659 <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
661 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignInSchemeAsync">
\r
663 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
664 This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
\r
665 Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
\r
667 <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
669 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignOutSchemeAsync">
\r
671 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
672 This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
\r
673 Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignInSchemeAsync"/> .
\r
675 <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
677 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.AddScheme(Microsoft.AspNetCore.Authentication.AuthenticationScheme)">
\r
679 Registers a scheme for use by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
\r
681 <param name="scheme">The scheme.</param>
\r
683 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.RemoveScheme(System.String)">
\r
685 Removes a scheme, preventing it from being used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
\r
687 <param name="name">The name of the authenticationScheme being removed.</param>
\r
689 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetRequestHandlerSchemesAsync">
\r
691 Returns the schemes in priority order for request handling.
\r
693 <returns>The schemes in priority order for request handling</returns>
\r
695 <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationService">
\r
697 Used to provide authentication.
\r
700 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
\r
702 Authenticate for the specified authentication scheme.
\r
704 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
\r
705 <param name="scheme">The name of the authentication scheme.</param>
\r
706 <returns>The result.</returns>
\r
708 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
710 Challenge the specified authentication scheme.
\r
712 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
\r
713 <param name="scheme">The name of the authentication scheme.</param>
\r
714 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
\r
715 <returns>A task.</returns>
\r
717 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
719 Forbids the specified authentication scheme.
\r
721 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
\r
722 <param name="scheme">The name of the authentication scheme.</param>
\r
723 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
\r
724 <returns>A task.</returns>
\r
726 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
728 Sign a principal in for the specified authentication scheme.
\r
730 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
\r
731 <param name="scheme">The name of the authentication scheme.</param>
\r
732 <param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to sign in.</param>
\r
733 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
\r
734 <returns>A task.</returns>
\r
736 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
738 Sign out the specified authentication scheme.
\r
740 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
\r
741 <param name="scheme">The name of the authentication scheme.</param>
\r
742 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
\r
743 <returns>A task.</returns>
\r
745 <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler">
\r
747 Used to determine if a handler supports SignIn.
\r
750 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler.SignInAsync(System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
754 <param name="user">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> user.</param>
\r
755 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
\r
756 <returns>A task.</returns>
\r
758 <member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler">
\r
760 Used to determine if a handler supports SignOut.
\r
763 <member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler.SignOutAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
767 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
\r
768 <returns>A task.</returns>
\r
770 <member name="T:Microsoft.AspNetCore.Authentication.IClaimsTransformation">
\r
772 Used by the <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/> for claims transformation.
\r
775 <member name="M:Microsoft.AspNetCore.Authentication.IClaimsTransformation.TransformAsync(System.Security.Claims.ClaimsPrincipal)">
\r
777 Provides a central transformation point to change the specified principal.
\r
778 Note: this will be run on each AuthenticateAsync call, so its safer to
\r
779 return a new ClaimsPrincipal if your transformation is not idempotent.
\r
781 <param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to transform.</param>
\r
782 <returns>The transformed principal.</returns>
\r
784 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions">
\r
786 Extension methods for storing authentication tokens in <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.
\r
789 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.StoreTokens(Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authentication.AuthenticationToken})">
\r
791 Stores a set of authentication tokens, after removing any old tokens.
\r
793 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
794 <param name="tokens">The tokens to store.</param>
\r
796 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenValue(Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.String)">
\r
798 Returns the value of a token.
\r
800 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
801 <param name="tokenName">The token name.</param>
\r
802 <returns>The token value.</returns>
\r
804 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokens(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
806 Returns all of the AuthenticationTokens contained in the properties.
\r
808 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
\r
809 <returns>The authentication tokens.</returns>
\r
811 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenAsync(Microsoft.AspNetCore.Authentication.IAuthenticationService,Microsoft.AspNetCore.Http.HttpContext,System.String)">
\r
813 Extension method for getting the value of an authentication token.
\r
815 <param name="auth">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.</param>
\r
816 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
817 <param name="tokenName">The name of the token.</param>
\r
818 <returns>The value of the token.</returns>
\r
820 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenAsync(Microsoft.AspNetCore.Authentication.IAuthenticationService,Microsoft.AspNetCore.Http.HttpContext,System.String,System.String)">
\r
822 Extension method for getting the value of an authentication token.
\r
824 <param name="auth">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.</param>
\r
825 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
\r
826 <param name="scheme">The name of the authentication scheme.</param>
\r
827 <param name="tokenName">The name of the token.</param>
\r
828 <returns>The value of the token.</returns>
\r