Microsoft.AspNetCore.Authentication.Abstractions.xml 53 KB

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