Microsoft.AspNetCore.Authentication.Core.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  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. Creates an instance of <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider"/>
  74. using the specified <paramref name="options"/>,
  75. </summary>
  76. <param name="options">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/> options.</param>
  77. </member>
  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})">
  79. <summary>
  80. Creates an instance of <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider"/>
  81. using the specified <paramref name="options"/> and <paramref name="schemes"/>.
  82. </summary>
  83. <param name="options">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/> options.</param>
  84. <param name="schemes">The dictionary used to store authentication schemes.</param>
  85. </member>
  86. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultAuthenticateSchemeAsync">
  87. <summary>
  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)"/>.
  89. This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/>.
  90. Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
  91. </summary>
  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>
  93. </member>
  94. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync">
  95. <summary>
  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)"/>.
  97. This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/>.
  98. Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
  99. </summary>
  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>
  101. </member>
  102. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultForbidSchemeAsync">
  103. <summary>
  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)"/>.
  105. This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.
  106. Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync"/> .
  107. </summary>
  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>
  109. </member>
  110. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignInSchemeAsync">
  111. <summary>
  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)"/>.
  113. This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
  114. Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
  115. </summary>
  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>
  117. </member>
  118. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignOutSchemeAsync">
  119. <summary>
  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)"/>.
  121. This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
  122. Otherwise this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignInSchemeAsync"/> if that supoorts sign out.
  123. </summary>
  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>
  125. </member>
  126. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetSchemeAsync(System.String)">
  127. <summary>
  128. Returns the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> matching the name, or null.
  129. </summary>
  130. <param name="name">The name of the authenticationScheme.</param>
  131. <returns>The scheme or null if not found.</returns>
  132. </member>
  133. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetRequestHandlerSchemesAsync">
  134. <summary>
  135. Returns the schemes in priority order for request handling.
  136. </summary>
  137. <returns>The schemes in priority order for request handling</returns>
  138. </member>
  139. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.AddScheme(Microsoft.AspNetCore.Authentication.AuthenticationScheme)">
  140. <summary>
  141. Registers a scheme for use by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
  142. </summary>
  143. <param name="scheme">The scheme.</param>
  144. </member>
  145. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.RemoveScheme(System.String)">
  146. <summary>
  147. Removes a scheme, preventing it from being used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
  148. </summary>
  149. <param name="name">The name of the authenticationScheme being removed.</param>
  150. </member>
  151. <member name="T:Microsoft.AspNetCore.Authentication.AuthenticationService">
  152. <summary>
  153. Implements <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
  154. </summary>
  155. </member>
  156. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.#ctor(Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider,Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider,Microsoft.AspNetCore.Authentication.IClaimsTransformation)">
  157. <summary>
  158. Constructor.
  159. </summary>
  160. <param name="schemes">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider"/>.</param>
  161. <param name="handlers">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler"/>.</param>
  162. <param name="transform">The <see cref="T:Microsoft.AspNetCore.Authentication.IClaimsTransformation"/>.</param>
  163. </member>
  164. <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Schemes">
  165. <summary>
  166. Used to lookup AuthenticationSchemes.
  167. </summary>
  168. </member>
  169. <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Handlers">
  170. <summary>
  171. Used to resolve IAuthenticationHandler instances.
  172. </summary>
  173. </member>
  174. <member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Transform">
  175. <summary>
  176. Used for claims transformation.
  177. </summary>
  178. </member>
  179. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
  180. <summary>
  181. Authenticate for the specified authentication scheme.
  182. </summary>
  183. <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
  184. <param name="scheme">The name of the authentication scheme.</param>
  185. <returns>The result.</returns>
  186. </member>
  187. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
  188. <summary>
  189. Challenge 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.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
  197. <summary>
  198. Forbid 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="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
  203. <returns>A task.</returns>
  204. </member>
  205. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
  206. <summary>
  207. Sign a principal in for the specified authentication scheme.
  208. </summary>
  209. <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
  210. <param name="scheme">The name of the authentication scheme.</param>
  211. <param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to sign in.</param>
  212. <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
  213. <returns>A task.</returns>
  214. </member>
  215. <member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
  216. <summary>
  217. Sign out the specified authentication scheme.
  218. </summary>
  219. <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
  220. <param name="scheme">The name of the authentication scheme.</param>
  221. <param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
  222. <returns>A task.</returns>
  223. </member>
  224. <member name="T:Microsoft.AspNetCore.Authentication.NoopClaimsTransformation">
  225. <summary>
  226. Default claims transformation is a no-op.
  227. </summary>
  228. </member>
  229. <member name="M:Microsoft.AspNetCore.Authentication.NoopClaimsTransformation.TransformAsync(System.Security.Claims.ClaimsPrincipal)">
  230. <summary>
  231. Returns the principal unchanged.
  232. </summary>
  233. <param name="principal">The user.</param>
  234. <returns>The principal unchanged.</returns>
  235. </member>
  236. </members>
  237. </doc>