Tools/dotnetcli/sdk/NuGetFallbackFolder/microsoft.aspnetcore.authentication.core/2.0.1/lib/netstandard2.0/Microsoft.AspNetCore.Authentication.Core.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Microsoft.AspNetCore.Authentication.Core</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Microsoft.Extensions.DependencyInjection.AuthenticationCoreServiceCollectionExtensions">
   8             <summary>
   9             Extension methods for setting up authentication services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  10             </summary>
  11         </member>
  12         <member name="M:Microsoft.Extensions.DependencyInjection.AuthenticationCoreServiceCollectionExtensions.AddAuthenticationCore(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  13             <summary>
  14             Add core authentication services needed for <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
  15             </summary>
  16             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  17             <returns>The service collection.</returns>
  18         </member>
  19         <member name="M:Microsoft.Extensions.DependencyInjection.AuthenticationCoreServiceCollectionExtensions.AddAuthenticationCore(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.Authentication.AuthenticationOptions})">
  20             <summary>
  21             Add core authentication services needed for <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
  22             </summary>
  23             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
  24             <param name="configureOptions">Used to configure the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/>.</param>
  25             <returns>The service collection.</returns>
  26         </member>
  27         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationFeature">
  28             <summary>
  29             Used to capture path info so redirects can be computed properly within an app.Map().
  30             </summary>
  31         </member>
  32         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationFeature.OriginalPathBase">
  33             <summary>
  34             The original path base.
  35             </summary>
  36         </member>
  37         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationFeature.OriginalPath">
  38             <summary>
  39             The original path.
  40             </summary>
  41         </member>
  42         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider">
  43             <summary>
  44             Implementation of <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider"/>.
  45             </summary>
  46         </member>
  47         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider.#ctor(Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider)">
  48             <summary>
  49             Constructor.
  50             </summary>
  51             <param name="schemes">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider"/>.</param>
  52         </member>
  53         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider.Schemes">
  54             <summary>
  55             The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider"/>.
  56             </summary>
  57         </member>
  58         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider.GetHandlerAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
  59             <summary>
  60             Returns the handler instance that will be used.
  61             </summary>
  62             <param name="context">The context.</param>
  63             <param name="authenticationScheme">The name of the authentication scheme being handled.</param>
  64             <returns>The handler instance.</returns>
  65         </member>
  66         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider">
  67             <summary>
  68             Implements <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider"/>.
  69             </summary>
  70         </member>
  71         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Authentication.AuthenticationOptions})">
  72             <summary>
  73             Constructor.
  74             </summary>
  75             <param name="options">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/> options.</param>
  76         </member>
  77         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultAuthenticateSchemeAsync">
  78             <summary>
  79             Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.
  80             This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/>.
  81             Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
  82             </summary>
  83             <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>
  84         </member>
  85         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync">
  86             <summary>
  87             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)"/>.
  88             This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/>.
  89             Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
  90             </summary>
  91             <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>
  92         </member>
  93         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultForbidSchemeAsync">
  94             <summary>
  95             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)"/>.
  96             This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.
  97             Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync"/> .
  98             </summary>
  99             <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>
 100         </member>
 101         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignInSchemeAsync">
 102             <summary>
 103             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)"/>.
 104             This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
 105             Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
 106             </summary>
 107             <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>
 108         </member>
 109         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignOutSchemeAsync">
 110             <summary>
 111             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)"/>.
 112             This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
 113             Otherwise this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignInSchemeAsync"/> if that supoorts sign out.
 114             </summary>
 115             <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>
 116         </member>
 117         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetSchemeAsync(System.String)">
 118             <summary>
 119             Returns the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> matching the name, or null.
 120             </summary>
 121             <param name="name">The name of the authenticationScheme.</param>
 122             <returns>The scheme or null if not found.</returns>
 123         </member>
 124         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetRequestHandlerSchemesAsync">
 125             <summary>
 126             Returns the schemes in priority order for request handling.
 127             </summary>
 128             <returns>The schemes in priority order for request handling</returns>
 129         </member>
 130         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.AddScheme(Microsoft.AspNetCore.Authentication.AuthenticationScheme)">
 131             <summary>
 132             Registers a scheme for use by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
 133             </summary>
 134             <param name="scheme">The scheme.</param>
 135         </member>
 136         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.RemoveScheme(System.String)">
 137             <summary>
 138             Removes a scheme, preventing it from being used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
 139             </summary>
 140             <param name="name">The name of the authenticationScheme being removed.</param>
 141         </member>
 142         <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationService">
 143             <summary>
 144             Implements <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
 145             </summary>
 146         </member>
 147         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.#ctor(Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider,Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider,Microsoft.AspNetCore.Authentication.IClaimsTransformation)">
 148             <summary>
 149             Constructor.
 150             </summary>
 151             <param name="schemes">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider"/>.</param>
 152             <param name="handlers">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler"/>.</param>
 153             <param name="transform">The The <see cref="T:Microsoft.AspNetCore.Authentication.IClaimsTransformation"/>.</param>
 154         </member>
 155         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Schemes">
 156             <summary>
 157             Used to lookup AuthenticationSchemes.
 158             </summary>
 159         </member>
 160         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Handlers">
 161             <summary>
 162             Used to resolve IAuthenticationHandler instances.
 163             </summary>
 164         </member>
 165         <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Transform">
 166             <summary>
 167             Used for claims transformation.
 168             </summary>
 169         </member>
 170         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
 171             <summary>
 172             Authenticate for the specified authentication scheme.
 173             </summary>
 174             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
 175             <param name="scheme">The name of the authentication scheme.</param>
 176             <returns>The result.</returns>
 177         </member>
 178         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
 179             <summary>
 180             Challenge the specified authentication scheme.
 181             </summary>
 182             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
 183             <param name="scheme">The name of the authentication scheme.</param>
 184             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
 185             <returns>A task.</returns>
 186         </member>
 187         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
 188             <summary>
 189             Forbid the specified authentication scheme.
 190             </summary>
 191             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
 192             <param name="scheme">The name of the authentication scheme.</param>
 193             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
 194             <returns>A task.</returns>
 195         </member>
 196         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
 197             <summary>
 198             Sign a principal in for the specified authentication scheme.
 199             </summary>
 200             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
 201             <param name="scheme">The name of the authentication scheme.</param>
 202             <param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to sign in.</param>
 203             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
 204             <returns>A task.</returns>
 205         </member>
 206         <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
 207             <summary>
 208             Sign out the specified authentication scheme.
 209             </summary>
 210             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
 211             <param name="scheme">The name of the authentication scheme.</param>
 212             <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
 213             <returns>A task.</returns>
 214         </member>
 215         <member name="T:Microsoft.AspNetCore.Authentication.NoopClaimsTransformation">
 216             <summary>
 217             Default claims transformation is a no-op.
 218             </summary>
 219         </member>
 220         <member name="M:Microsoft.AspNetCore.Authentication.NoopClaimsTransformation.TransformAsync(System.Security.Claims.ClaimsPrincipal)">
 221             <summary>
 222             Returns the principal unchanged.
 223             </summary>
 224             <param name="principal">The user.</param>
 225             <returns>The principal unchanged.</returns>
 226         </member>
 227     </members>
 228 </doc>