1 <?xml version="1.0"?>
\r
4 <name>Microsoft.AspNetCore.Authentication.Core</name>
\r
7 <member name="T:Microsoft.Extensions.DependencyInjection.AuthenticationCoreServiceCollectionExtensions">
\r
9 Extension methods for setting up authentication services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
\r
12 <member name="M:Microsoft.Extensions.DependencyInjection.AuthenticationCoreServiceCollectionExtensions.AddAuthenticationCore(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
\r
14 Add core authentication services needed for <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
\r
16 <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
\r
17 <returns>The service collection.</returns>
\r
19 <member name="M:Microsoft.Extensions.DependencyInjection.AuthenticationCoreServiceCollectionExtensions.AddAuthenticationCore(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.Authentication.AuthenticationOptions})">
\r
21 Add core authentication services needed for <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
\r
23 <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
\r
24 <param name="configureOptions">Used to configure the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/>.</param>
\r
25 <returns>The service collection.</returns>
\r
27 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationFeature">
\r
29 Used to capture path info so redirects can be computed properly within an app.Map().
\r
32 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationFeature.OriginalPathBase">
\r
34 The original path base.
\r
37 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationFeature.OriginalPath">
\r
42 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider">
\r
44 Implementation of <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider"/>.
\r
47 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider.#ctor(Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider)">
\r
51 <param name="schemes">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider"/>.</param>
\r
53 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider.Schemes">
\r
55 The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider"/>.
\r
58 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider.GetHandlerAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
\r
60 Returns the handler instance that will be used.
\r
62 <param name="context">The context.</param>
\r
63 <param name="authenticationScheme">The name of the authentication scheme being handled.</param>
\r
64 <returns>The handler instance.</returns>
\r
66 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider">
\r
68 Implements <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider"/>.
\r
71 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Authentication.AuthenticationOptions})">
\r
73 Creates an instance of <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider"/>
\r
74 using the specified <paramref name="options"/>,
\r
76 <param name="options">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/> options.</param>
\r
78 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Authentication.AuthenticationOptions},System.Collections.Generic.IDictionary{System.String,Microsoft.AspNetCore.Authentication.AuthenticationScheme})">
\r
80 Creates an instance of <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider"/>
\r
81 using the specified <paramref name="options"/> and <paramref name="schemes"/>.
\r
83 <param name="options">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/> options.</param>
\r
84 <param name="schemes">The dictionary used to store authentication schemes.</param>
\r
86 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultAuthenticateSchemeAsync">
\r
88 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
89 This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/>.
\r
90 Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
\r
92 <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
94 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync">
\r
96 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
97 This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/>.
\r
98 Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
\r
100 <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
102 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultForbidSchemeAsync">
\r
104 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
105 This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.
\r
106 Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync"/> .
\r
108 <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
110 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignInSchemeAsync">
\r
112 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
113 This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
\r
114 Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
\r
116 <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
118 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignOutSchemeAsync">
\r
120 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
121 This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
\r
122 Otherwise this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignInSchemeAsync"/> if that supports sign out.
\r
124 <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
126 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetSchemeAsync(System.String)">
\r
128 Returns the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> matching the name, or null.
\r
130 <param name="name">The name of the authenticationScheme.</param>
\r
131 <returns>The scheme or null if not found.</returns>
\r
133 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetRequestHandlerSchemesAsync">
\r
135 Returns the schemes in priority order for request handling.
\r
137 <returns>The schemes in priority order for request handling</returns>
\r
139 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.AddScheme(Microsoft.AspNetCore.Authentication.AuthenticationScheme)">
\r
141 Registers a scheme for use by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
\r
143 <param name="scheme">The scheme.</param>
\r
145 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.RemoveScheme(System.String)">
\r
147 Removes a scheme, preventing it from being used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
\r
149 <param name="name">The name of the authenticationScheme being removed.</param>
\r
151 <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationService">
\r
153 Implements <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
\r
156 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.#ctor(Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider,Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider,Microsoft.AspNetCore.Authentication.IClaimsTransformation,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Authentication.AuthenticationOptions})">
\r
160 <param name="schemes">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider"/>.</param>
\r
161 <param name="handlers">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider"/>.</param>
\r
162 <param name="transform">The <see cref="T:Microsoft.AspNetCore.Authentication.IClaimsTransformation"/>.</param>
\r
163 <param name="options">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/>.</param>
\r
165 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Schemes">
\r
167 Used to lookup AuthenticationSchemes.
\r
170 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Handlers">
\r
172 Used to resolve IAuthenticationHandler instances.
\r
175 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Transform">
\r
177 Used for claims transformation.
\r
180 <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Options">
\r
182 The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/>.
\r
185 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
\r
187 Authenticate for the specified authentication scheme.
\r
189 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
\r
190 <param name="scheme">The name of the authentication scheme.</param>
\r
191 <returns>The result.</returns>
\r
193 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
195 Challenge the specified authentication scheme.
\r
197 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
\r
198 <param name="scheme">The name of the authentication scheme.</param>
\r
199 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
\r
200 <returns>A task.</returns>
\r
202 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
204 Forbid the specified authentication scheme.
\r
206 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
\r
207 <param name="scheme">The name of the authentication scheme.</param>
\r
208 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
\r
209 <returns>A task.</returns>
\r
211 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
213 Sign a principal in for the specified authentication scheme.
\r
215 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
\r
216 <param name="scheme">The name of the authentication scheme.</param>
\r
217 <param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to sign in.</param>
\r
218 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
\r
219 <returns>A task.</returns>
\r
221 <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
\r
223 Sign out the specified authentication scheme.
\r
225 <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
\r
226 <param name="scheme">The name of the authentication scheme.</param>
\r
227 <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
\r
228 <returns>A task.</returns>
\r
230 <member name="T:Microsoft.AspNetCore.Authentication.NoopClaimsTransformation">
\r
232 Default claims transformation is a no-op.
\r
235 <member name="M:Microsoft.AspNetCore.Authentication.NoopClaimsTransformation.TransformAsync(System.Security.Claims.ClaimsPrincipal)">
\r
237 Returns the principal unchanged.
\r
239 <param name="principal">The user.</param>
\r
240 <returns>The principal unchanged.</returns>
\r