You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

545 lines
32 KiB

4 years ago
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Owin.Security.Cookies</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Owin.Security.Cookies.CookieAuthenticationDefaults">
  8. <summary>
  9. Default values related to cookie-based authentication middleware
  10. </summary>
  11. </member>
  12. <member name="F:Microsoft.Owin.Security.Cookies.CookieAuthenticationDefaults.AuthenticationType">
  13. <summary>
  14. The default value used for CookieAuthenticationOptions.AuthenticationType
  15. </summary>
  16. </member>
  17. <member name="F:Microsoft.Owin.Security.Cookies.CookieAuthenticationDefaults.CookiePrefix">
  18. <summary>
  19. The prefix used to provide a default CookieAuthenticationOptions.CookieName
  20. </summary>
  21. </member>
  22. <member name="F:Microsoft.Owin.Security.Cookies.CookieAuthenticationDefaults.ReturnUrlParameter">
  23. <summary>
  24. The default value of the CookieAuthenticationOptions.ReturnUrlParameter
  25. </summary>
  26. </member>
  27. <member name="F:Microsoft.Owin.Security.Cookies.CookieAuthenticationDefaults.LoginPath">
  28. <summary>
  29. The default value used by UseApplicationSignInCookie for the
  30. CookieAuthenticationOptions.LoginPath
  31. </summary>
  32. </member>
  33. <member name="F:Microsoft.Owin.Security.Cookies.CookieAuthenticationDefaults.LogoutPath">
  34. <summary>
  35. The default value used by UseApplicationSignInCookie for the
  36. CookieAuthenticationOptions.LogoutPath
  37. </summary>
  38. </member>
  39. <member name="T:Microsoft.Owin.Security.Cookies.CookieSecureOption">
  40. <summary>
  41. Determines how the identity cookie's security property is set.
  42. </summary>
  43. </member>
  44. <member name="F:Microsoft.Owin.Security.Cookies.CookieSecureOption.SameAsRequest">
  45. <summary>
  46. If the URI that provides the cookie is HTTPS, then the cookie will only be returned to the server on
  47. subsequent HTTPS requests. Otherwise if the URI that provides the cookie is HTTP, then the cookie will
  48. be returned to the server on all HTTP and HTTPS requests. This is the default value because it ensures
  49. HTTPS for all authenticated requests on deployed servers, and also supports HTTP for localhost development
  50. and for servers that do not have HTTPS support.
  51. </summary>
  52. </member>
  53. <member name="F:Microsoft.Owin.Security.Cookies.CookieSecureOption.Never">
  54. <summary>
  55. CookieOptions.Secure is never marked true. Use this value when your login page is HTTPS, but other pages
  56. on the site which are HTTP also require authentication information. This setting is not recommended because
  57. the authentication information provided with an HTTP request may be observed and used by other computers
  58. on your local network or wireless connection.
  59. </summary>
  60. </member>
  61. <member name="F:Microsoft.Owin.Security.Cookies.CookieSecureOption.Always">
  62. <summary>
  63. CookieOptions.Secure is always marked true. Use this value when your login page and all subsequent pages
  64. requiring the authenticated identity are HTTPS. Local development will also need to be done with HTTPS urls.
  65. </summary>
  66. </member>
  67. <member name="T:Owin.CookieAuthenticationExtensions">
  68. <summary>
  69. Extension methods provided by the cookies authentication middleware
  70. </summary>
  71. </member>
  72. <member name="M:Owin.CookieAuthenticationExtensions.UseCookieAuthentication(Owin.IAppBuilder,Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions)">
  73. <summary>
  74. Adds a cookie-based authentication middleware to your web application pipeline.
  75. </summary>
  76. <param name="app">The IAppBuilder passed to your configuration method</param>
  77. <param name="options">An options class that controls the middleware behavior</param>
  78. <returns>The original app parameter</returns>
  79. </member>
  80. <member name="M:Owin.CookieAuthenticationExtensions.UseCookieAuthentication(Owin.IAppBuilder,Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions,Owin.PipelineStage)">
  81. <summary>
  82. Adds a cookie-based authentication middleware to your web application pipeline.
  83. </summary>
  84. <param name="app">The IAppBuilder passed to your configuration method</param>
  85. <param name="options">An options class that controls the middleware behavior</param>
  86. <param name="stage"></param>
  87. <returns>The original app parameter</returns>
  88. </member>
  89. <member name="T:Microsoft.Owin.Security.Cookies.CookieAuthenticationMiddleware">
  90. <summary>
  91. Cookie based authentication middleware
  92. </summary>
  93. </member>
  94. <member name="M:Microsoft.Owin.Security.Cookies.CookieAuthenticationMiddleware.#ctor(Microsoft.Owin.OwinMiddleware,Owin.IAppBuilder,Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions)">
  95. <summary>
  96. Initializes a <see cref="T:Microsoft.Owin.Security.Cookies.CookieAuthenticationMiddleware"/>
  97. </summary>
  98. <param name="next">The next middleware in the OWIN pipeline to invoke</param>
  99. <param name="app">The OWIN application</param>
  100. <param name="options">Configuration options for the middleware</param>
  101. </member>
  102. <member name="M:Microsoft.Owin.Security.Cookies.CookieAuthenticationMiddleware.CreateHandler">
  103. <summary>
  104. Provides the <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> object for processing authentication-related requests.
  105. </summary>
  106. <returns>An <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> configured with the <see cref="T:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions"/> supplied to the constructor.</returns>
  107. </member>
  108. <member name="T:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions">
  109. <summary>
  110. Contains the options used by the CookiesAuthenticationMiddleware
  111. </summary>
  112. </member>
  113. <member name="M:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.#ctor">
  114. <summary>
  115. Create an instance of the options initialized with the default values
  116. </summary>
  117. </member>
  118. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.CookieName">
  119. <summary>
  120. Determines the cookie name used to persist the identity. The default value is ".AspNet.Cookies".
  121. This value should be changed if you change the name of the AuthenticationType, especially if your
  122. system uses the cookie authentication middleware multiple times.
  123. </summary>
  124. </member>
  125. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.CookieDomain">
  126. <summary>
  127. Determines the domain used to create the cookie. Is not provided by default.
  128. </summary>
  129. </member>
  130. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.CookiePath">
  131. <summary>
  132. Determines the path used to create the cookie. The default value is "/" for highest browser compatability.
  133. </summary>
  134. </member>
  135. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.CookieHttpOnly">
  136. <summary>
  137. Determines if the browser should allow the cookie to be accessed by client-side javascript. The
  138. default is true, which means the cookie will only be passed to http requests and is not made available
  139. to script on the page.
  140. </summary>
  141. </member>
  142. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.CookieSecure">
  143. <summary>
  144. Determines if the cookie should only be transmitted on HTTPS request. The default is to limit the cookie
  145. to HTTPS requests if the page which is doing the SignIn is also HTTPS. If you have an HTTPS sign in page
  146. and portions of your site are HTTP you may need to change this value.
  147. </summary>
  148. </member>
  149. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.ExpireTimeSpan">
  150. <summary>
  151. Controls how much time the cookie will remain valid from the point it is created. The expiration
  152. information is in the protected cookie ticket. Because of that an expired cookie will be ignored
  153. even if it is passed to the server after the browser should have purged it
  154. </summary>
  155. </member>
  156. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.SlidingExpiration">
  157. <summary>
  158. The SlidingExpiration is set to true to instruct the middleware to re-issue a new cookie with a new
  159. expiration time any time it processes a request which is more than halfway through the expiration window.
  160. </summary>
  161. </member>
  162. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.LoginPath">
  163. <summary>
  164. The LoginPath property informs the middleware that it should change an outgoing 401 Unauthorized status
  165. code into a 302 redirection onto the given login path. The current url which generated the 401 is added
  166. to the LoginPath as a query string parameter named by the ReturnUrlParameter. Once a request to the
  167. LoginPath grants a new SignIn identity, the ReturnUrlParameter value is used to redirect the browser back
  168. to the url which caused the original unauthorized status code.
  169. If the LoginPath is null or empty, the middleware will not look for 401 Unauthorized status codes, and it will
  170. not redirect automatically when a login occurs.
  171. </summary>
  172. </member>
  173. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.LogoutPath">
  174. <summary>
  175. If the LogoutPath is provided the middleware then a request to that path will redirect based on the ReturnUrlParameter.
  176. </summary>
  177. </member>
  178. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.ReturnUrlParameter">
  179. <summary>
  180. The ReturnUrlParameter determines the name of the query string parameter which is appended by the middleware
  181. when a 401 Unauthorized status code is changed to a 302 redirect onto the login path. This is also the query
  182. string parameter looked for when a request arrives on the login path or logout path, in order to return to the
  183. original url after the action is performed.
  184. </summary>
  185. </member>
  186. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.Provider">
  187. <summary>
  188. The Provider may be assigned to an instance of an object created by the application at startup time. The middleware
  189. calls methods on the provider which give the application control at certain points where processing is occuring.
  190. If it is not provided a default instance is supplied which does nothing when the methods are called.
  191. </summary>
  192. </member>
  193. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.TicketDataFormat">
  194. <summary>
  195. The TicketDataFormat is used to protect and unprotect the identity and other properties which are stored in the
  196. cookie value. If it is not provided a default data handler is created using the data protection service contained
  197. in the IAppBuilder.Properties. The default data protection service is based on machine key when running on ASP.NET,
  198. and on DPAPI when running in a different process.
  199. </summary>
  200. </member>
  201. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.SystemClock">
  202. <summary>
  203. The SystemClock provides access to the system's current time coordinates. If it is not provided a default instance is
  204. used which calls DateTimeOffset.UtcNow. This is typically not replaced except for unit testing.
  205. </summary>
  206. </member>
  207. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.CookieManager">
  208. <summary>
  209. The component used to get cookies from the request or set them on the response.
  210. ChunkingCookieManager will be used by default.
  211. </summary>
  212. </member>
  213. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions.SessionStore">
  214. <summary>
  215. An optional container in which to store the identity across requests. When used, only a session identifier is sent
  216. to the client. This can be used to mitigate potential problems with very large identities.
  217. </summary>
  218. </member>
  219. <member name="T:Microsoft.Owin.Security.Cookies.CookieApplyRedirectContext">
  220. <summary>
  221. Context passed when a Challenge, SignIn, or SignOut causes a redirect in the cookie middleware
  222. </summary>
  223. </member>
  224. <member name="M:Microsoft.Owin.Security.Cookies.CookieApplyRedirectContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions,System.String)">
  225. <summary>
  226. Creates a new context object.
  227. </summary>
  228. <param name="context">The OWIN request context</param>
  229. <param name="options">The cookie middleware options</param>
  230. <param name="redirectUri">The initial redirect URI</param>
  231. </member>
  232. <member name="P:Microsoft.Owin.Security.Cookies.CookieApplyRedirectContext.RedirectUri">
  233. <summary>
  234. Gets or Sets the URI used for the redirect operation.
  235. </summary>
  236. </member>
  237. <member name="T:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider">
  238. <summary>
  239. This default implementation of the ICookieAuthenticationProvider may be used if the
  240. application only needs to override a few of the interface methods. This may be used as a base class
  241. or may be instantiated directly.
  242. </summary>
  243. </member>
  244. <member name="T:Microsoft.Owin.Security.Cookies.ICookieAuthenticationProvider">
  245. <summary>
  246. Specifies callback methods which the <see cref="T:Microsoft.Owin.Security.Cookies.CookieAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. /&gt;
  247. </summary>
  248. </member>
  249. <member name="M:Microsoft.Owin.Security.Cookies.ICookieAuthenticationProvider.ValidateIdentity(Microsoft.Owin.Security.Cookies.CookieValidateIdentityContext)">
  250. <summary>
  251. Called each time a request identity has been validated by the middleware. By implementing this method the
  252. application may alter or reject the identity which has arrived with the request.
  253. </summary>
  254. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  255. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  256. </member>
  257. <member name="M:Microsoft.Owin.Security.Cookies.ICookieAuthenticationProvider.ResponseSignIn(Microsoft.Owin.Security.Cookies.CookieResponseSignInContext)">
  258. <summary>
  259. Called when an endpoint has provided sign in information before it is converted into a cookie. By
  260. implementing this method the claims and extra information that go into the ticket may be altered.
  261. </summary>
  262. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  263. </member>
  264. <member name="M:Microsoft.Owin.Security.Cookies.ICookieAuthenticationProvider.ResponseSignedIn(Microsoft.Owin.Security.Cookies.CookieResponseSignedInContext)">
  265. <summary>
  266. Called when an endpoint has provided sign in information after it is converted into a cookie.
  267. </summary>
  268. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  269. </member>
  270. <member name="M:Microsoft.Owin.Security.Cookies.ICookieAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.Cookies.CookieApplyRedirectContext)">
  271. <summary>
  272. Called when a Challenge, SignIn, or SignOut causes a redirect in the cookie middleware
  273. </summary>
  274. <param name="context">Contains information about the event</param>
  275. </member>
  276. <member name="M:Microsoft.Owin.Security.Cookies.ICookieAuthenticationProvider.ResponseSignOut(Microsoft.Owin.Security.Cookies.CookieResponseSignOutContext)">
  277. <summary>
  278. Called during the sign-out flow to augment the cookie cleanup process.
  279. </summary>
  280. <param name="context">Contains information about the login session as well as information about the authentication cookie.</param>
  281. </member>
  282. <member name="M:Microsoft.Owin.Security.Cookies.ICookieAuthenticationProvider.Exception(Microsoft.Owin.Security.Cookies.CookieExceptionContext)">
  283. <summary>
  284. Called when an exception occurs during request or response processing.
  285. </summary>
  286. <param name="context">Contains information about the exception that occurred</param>
  287. </member>
  288. <member name="M:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.#ctor">
  289. <summary>
  290. Create a new instance of the default provider.
  291. </summary>
  292. </member>
  293. <member name="M:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.ValidateIdentity(Microsoft.Owin.Security.Cookies.CookieValidateIdentityContext)">
  294. <summary>
  295. Implements the interface method by invoking the related delegate method
  296. </summary>
  297. <param name="context"></param>
  298. <returns></returns>
  299. </member>
  300. <member name="M:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.ResponseSignIn(Microsoft.Owin.Security.Cookies.CookieResponseSignInContext)">
  301. <summary>
  302. Implements the interface method by invoking the related delegate method
  303. </summary>
  304. <param name="context"></param>
  305. </member>
  306. <member name="M:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.ResponseSignedIn(Microsoft.Owin.Security.Cookies.CookieResponseSignedInContext)">
  307. <summary>
  308. Implements the interface method by invoking the related delegate method
  309. </summary>
  310. <param name="context"></param>
  311. </member>
  312. <member name="M:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.ResponseSignOut(Microsoft.Owin.Security.Cookies.CookieResponseSignOutContext)">
  313. <summary>
  314. Implements the interface method by invoking the related delegate method
  315. </summary>
  316. <param name="context"></param>
  317. </member>
  318. <member name="M:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.Cookies.CookieApplyRedirectContext)">
  319. <summary>
  320. Implements the interface method by invoking the related delegate method
  321. </summary>
  322. <param name="context">Contains information about the event</param>
  323. </member>
  324. <member name="M:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.Exception(Microsoft.Owin.Security.Cookies.CookieExceptionContext)">
  325. <summary>
  326. Implements the interface method by invoking the related delegate method
  327. </summary>
  328. <param name="context">Contains information about the event</param>
  329. </member>
  330. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.OnValidateIdentity">
  331. <summary>
  332. A delegate assigned to this property will be invoked when the related method is called
  333. </summary>
  334. </member>
  335. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.OnResponseSignIn">
  336. <summary>
  337. A delegate assigned to this property will be invoked when the related method is called
  338. </summary>
  339. </member>
  340. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.OnResponseSignedIn">
  341. <summary>
  342. A delegate assigned to this property will be invoked when the related method is called
  343. </summary>
  344. </member>
  345. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.OnResponseSignOut">
  346. <summary>
  347. A delegate assigned to this property will be invoked when the related method is called
  348. </summary>
  349. </member>
  350. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.OnApplyRedirect">
  351. <summary>
  352. A delegate assigned to this property will be invoked when the related method is called
  353. </summary>
  354. </member>
  355. <member name="P:Microsoft.Owin.Security.Cookies.CookieAuthenticationProvider.OnException">
  356. <summary>
  357. A delegate assigned to this property will be invoked when the related method is called
  358. </summary>
  359. </member>
  360. <member name="T:Microsoft.Owin.Security.Cookies.CookieExceptionContext">
  361. <summary>
  362. Context object passed to the ICookieAuthenticationProvider method Exception.
  363. </summary>
  364. </member>
  365. <member name="M:Microsoft.Owin.Security.Cookies.CookieExceptionContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions,Microsoft.Owin.Security.Cookies.CookieExceptionContext.ExceptionLocation,System.Exception,Microsoft.Owin.Security.AuthenticationTicket)">
  366. <summary>
  367. Creates a new instance of the context object.
  368. </summary>
  369. <param name="context">The OWIN request context</param>
  370. <param name="options">The middleware options</param>
  371. <param name="location">The location of the exception</param>
  372. <param name="exception">The exception thrown.</param>
  373. <param name="ticket">The current ticket, if any.</param>
  374. </member>
  375. <member name="P:Microsoft.Owin.Security.Cookies.CookieExceptionContext.Location">
  376. <summary>
  377. The code path the exception occurred in.
  378. </summary>
  379. </member>
  380. <member name="P:Microsoft.Owin.Security.Cookies.CookieExceptionContext.Exception">
  381. <summary>
  382. The exception thrown.
  383. </summary>
  384. </member>
  385. <member name="P:Microsoft.Owin.Security.Cookies.CookieExceptionContext.Rethrow">
  386. <summary>
  387. True if the exception should be re-thrown (default), false if it should be suppressed.
  388. </summary>
  389. </member>
  390. <member name="P:Microsoft.Owin.Security.Cookies.CookieExceptionContext.Ticket">
  391. <summary>
  392. The current authentication ticket, if any.
  393. In the AuthenticateAsync code path, if the given exception is not re-thrown then this ticket
  394. will be returned to the application. The ticket may be replaced if needed.
  395. </summary>
  396. </member>
  397. <member name="T:Microsoft.Owin.Security.Cookies.CookieExceptionContext.ExceptionLocation">
  398. <summary>
  399. The code paths where exceptions may be reported.
  400. </summary>
  401. </member>
  402. <member name="F:Microsoft.Owin.Security.Cookies.CookieExceptionContext.ExceptionLocation.AuthenticateAsync">
  403. <summary>
  404. The exception was reported in the AuthenticateAsync code path.
  405. </summary>
  406. </member>
  407. <member name="F:Microsoft.Owin.Security.Cookies.CookieExceptionContext.ExceptionLocation.ApplyResponseGrant">
  408. <summary>
  409. The exception was reported in the ApplyResponseGrant code path, during sign-in, sign-out, or refresh.
  410. </summary>
  411. </member>
  412. <member name="F:Microsoft.Owin.Security.Cookies.CookieExceptionContext.ExceptionLocation.ApplyResponseChallenge">
  413. <summary>
  414. The exception was reported in the ApplyResponseChallenge code path, during redirect generation.
  415. </summary>
  416. </member>
  417. <member name="T:Microsoft.Owin.Security.Cookies.CookieResponseSignedInContext">
  418. <summary>
  419. Context object passed to the ICookieAuthenticationProvider method ResponseSignedIn.
  420. </summary>
  421. </member>
  422. <member name="M:Microsoft.Owin.Security.Cookies.CookieResponseSignedInContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions,System.String,System.Security.Claims.ClaimsIdentity,Microsoft.Owin.Security.AuthenticationProperties)">
  423. <summary>
  424. Creates a new instance of the context object.
  425. </summary>
  426. <param name="context">The OWIN request context</param>
  427. <param name="options">The middleware options</param>
  428. <param name="authenticationType">Initializes AuthenticationType property</param>
  429. <param name="identity">Initializes Identity property</param>
  430. <param name="properties">Initializes Properties property</param>
  431. </member>
  432. <member name="P:Microsoft.Owin.Security.Cookies.CookieResponseSignedInContext.AuthenticationType">
  433. <summary>
  434. The name of the AuthenticationType creating a cookie
  435. </summary>
  436. </member>
  437. <member name="P:Microsoft.Owin.Security.Cookies.CookieResponseSignedInContext.Identity">
  438. <summary>
  439. Contains the claims that were converted into the outgoing cookie.
  440. </summary>
  441. </member>
  442. <member name="P:Microsoft.Owin.Security.Cookies.CookieResponseSignedInContext.Properties">
  443. <summary>
  444. Contains the extra data that was contained in the outgoing cookie.
  445. </summary>
  446. </member>
  447. <member name="T:Microsoft.Owin.Security.Cookies.CookieResponseSignInContext">
  448. <summary>
  449. Context object passed to the ICookieAuthenticationProvider method ResponseSignIn.
  450. </summary>
  451. </member>
  452. <member name="M:Microsoft.Owin.Security.Cookies.CookieResponseSignInContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions,System.String,System.Security.Claims.ClaimsIdentity,Microsoft.Owin.Security.AuthenticationProperties,Microsoft.Owin.CookieOptions)">
  453. <summary>
  454. Creates a new instance of the context object.
  455. </summary>
  456. <param name="context">The OWIN request context</param>
  457. <param name="options">The middleware options</param>
  458. <param name="authenticationType">Initializes AuthenticationType property</param>
  459. <param name="identity">Initializes Identity property</param>
  460. <param name="properties">Initializes Extra property</param>
  461. <param name="cookieOptions">Initializes options for the authentication cookie.</param>
  462. </member>
  463. <member name="P:Microsoft.Owin.Security.Cookies.CookieResponseSignInContext.AuthenticationType">
  464. <summary>
  465. The name of the AuthenticationType creating a cookie
  466. </summary>
  467. </member>
  468. <member name="P:Microsoft.Owin.Security.Cookies.CookieResponseSignInContext.Identity">
  469. <summary>
  470. Contains the claims about to be converted into the outgoing cookie.
  471. May be replaced or altered during the ResponseSignIn call.
  472. </summary>
  473. </member>
  474. <member name="P:Microsoft.Owin.Security.Cookies.CookieResponseSignInContext.Properties">
  475. <summary>
  476. Contains the extra data about to be contained in the outgoing cookie.
  477. May be replaced or altered during the ResponseSignIn call.
  478. </summary>
  479. </member>
  480. <member name="P:Microsoft.Owin.Security.Cookies.CookieResponseSignInContext.CookieOptions">
  481. <summary>
  482. The options for creating the outgoing cookie.
  483. May be replace or altered during the ResponseSignIn call.
  484. </summary>
  485. </member>
  486. <member name="T:Microsoft.Owin.Security.Cookies.CookieResponseSignOutContext">
  487. <summary>
  488. Context object passed to the ICookieAuthenticationProvider method ResponseSignOut
  489. </summary>
  490. </member>
  491. <member name="M:Microsoft.Owin.Security.Cookies.CookieResponseSignOutContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions,Microsoft.Owin.CookieOptions)">
  492. <summary>
  493. </summary>
  494. <param name="context"></param>
  495. <param name="options"></param>
  496. <param name="cookieOptions"></param>
  497. </member>
  498. <member name="P:Microsoft.Owin.Security.Cookies.CookieResponseSignOutContext.CookieOptions">
  499. <summary>
  500. The options for creating the outgoing cookie.
  501. May be replace or altered during the ResponseSignOut call.
  502. </summary>
  503. </member>
  504. <member name="T:Microsoft.Owin.Security.Cookies.CookieValidateIdentityContext">
  505. <summary>
  506. Context object passed to the ICookieAuthenticationProvider method ValidateIdentity.
  507. </summary>
  508. </member>
  509. <member name="M:Microsoft.Owin.Security.Cookies.CookieValidateIdentityContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.AuthenticationTicket,Microsoft.Owin.Security.Cookies.CookieAuthenticationOptions)">
  510. <summary>
  511. Creates a new instance of the context object.
  512. </summary>
  513. <param name="context"></param>
  514. <param name="ticket">Contains the initial values for identity and extra data</param>
  515. <param name="options"></param>
  516. </member>
  517. <member name="M:Microsoft.Owin.Security.Cookies.CookieValidateIdentityContext.ReplaceIdentity(System.Security.Principal.IIdentity)">
  518. <summary>
  519. Called to replace the claims identity. The supplied identity will replace the value of the
  520. Identity property, which determines the identity of the authenticated request.
  521. </summary>
  522. <param name="identity">The identity used as the replacement</param>
  523. </member>
  524. <member name="M:Microsoft.Owin.Security.Cookies.CookieValidateIdentityContext.RejectIdentity">
  525. <summary>
  526. Called to reject the incoming identity. This may be done if the application has determined the
  527. account is no longer active, and the request should be treated as if it was anonymous.
  528. </summary>
  529. </member>
  530. <member name="P:Microsoft.Owin.Security.Cookies.CookieValidateIdentityContext.Identity">
  531. <summary>
  532. Contains the claims identity arriving with the request. May be altered to change the
  533. details of the authenticated user.
  534. </summary>
  535. </member>
  536. <member name="P:Microsoft.Owin.Security.Cookies.CookieValidateIdentityContext.Properties">
  537. <summary>
  538. Contains the extra meta-data arriving with the request ticket. May be altered.
  539. </summary>
  540. </member>
  541. </members>
  542. </doc>