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.

397 lines
20 KiB

10 years ago
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.AspNet.Identity.Owin</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.AspNet.Identity.Owin.IdentityFactoryMiddleware`2">
  8. <summary>
  9. OwinMiddleware that initializes an object for use in the OwinContext via the Get/Set generic extensions method
  10. </summary>
  11. <typeparam name="TResult"></typeparam>
  12. <typeparam name="TOptions"></typeparam>
  13. </member>
  14. <member name="M:Microsoft.AspNet.Identity.Owin.IdentityFactoryMiddleware`2.#ctor(Microsoft.Owin.OwinMiddleware,`1)">
  15. <summary>
  16. Constructor
  17. </summary>
  18. <param name="next">The next middleware in the OWIN pipeline to invoke</param>
  19. <param name="options">Configuration options for the middleware</param>
  20. </member>
  21. <member name="M:Microsoft.AspNet.Identity.Owin.IdentityFactoryMiddleware`2.Invoke(Microsoft.Owin.IOwinContext)">
  22. <summary>
  23. Create an object using the Options.Provider, storing it in the OwinContext and then disposes the object when finished
  24. </summary>
  25. <param name="context"></param>
  26. <returns></returns>
  27. </member>
  28. <member name="P:Microsoft.AspNet.Identity.Owin.IdentityFactoryMiddleware`2.Options">
  29. <summary>
  30. Configuration options
  31. </summary>
  32. </member>
  33. <member name="T:Microsoft.AspNet.Identity.Owin.IdentityFactoryOptions`1">
  34. <summary>
  35. Configuration options for a IdentityFactoryMiddleware
  36. </summary>
  37. <typeparam name="T"></typeparam>
  38. </member>
  39. <member name="P:Microsoft.AspNet.Identity.Owin.IdentityFactoryOptions`1.DataProtectionProvider">
  40. <summary>
  41. Used to configure the data protection provider
  42. </summary>
  43. </member>
  44. <member name="P:Microsoft.AspNet.Identity.Owin.IdentityFactoryOptions`1.Provider">
  45. <summary>
  46. Provider used to Create and Dispose objects
  47. </summary>
  48. </member>
  49. <member name="T:Microsoft.AspNet.Identity.Owin.IIdentityFactoryProvider`1">
  50. <summary>
  51. Interface used to create objects per request
  52. </summary>
  53. <typeparam name="T"></typeparam>
  54. </member>
  55. <member name="M:Microsoft.AspNet.Identity.Owin.IIdentityFactoryProvider`1.Create(Microsoft.AspNet.Identity.Owin.IdentityFactoryOptions{`0},Microsoft.Owin.IOwinContext)">
  56. <summary>
  57. Called once per request to create an object
  58. </summary>
  59. <param name="options"></param>
  60. <param name="context"></param>
  61. <returns></returns>
  62. </member>
  63. <member name="M:Microsoft.AspNet.Identity.Owin.IIdentityFactoryProvider`1.Dispose(Microsoft.AspNet.Identity.Owin.IdentityFactoryOptions{`0},`0)">
  64. <summary>
  65. Called at the end of the request to dispose the object created
  66. </summary>
  67. <param name="options"></param>
  68. <param name="instance"></param>
  69. </member>
  70. <member name="T:Microsoft.AspNet.Identity.Owin.IdentityFactoryProvider`1">
  71. <summary>
  72. Used to configure how the IdentityFactoryMiddleware will create an instance of the specified type for each OwinContext
  73. </summary>
  74. <typeparam name="T"></typeparam>
  75. </member>
  76. <member name="M:Microsoft.AspNet.Identity.Owin.IdentityFactoryProvider`1.#ctor">
  77. <summary>
  78. Constructor
  79. </summary>
  80. </member>
  81. <member name="M:Microsoft.AspNet.Identity.Owin.IdentityFactoryProvider`1.Create(Microsoft.AspNet.Identity.Owin.IdentityFactoryOptions{`0},Microsoft.Owin.IOwinContext)">
  82. <summary>
  83. Calls the OnCreate Delegate
  84. </summary>
  85. <param name="options"></param>
  86. <param name="context"></param>
  87. <returns></returns>
  88. </member>
  89. <member name="M:Microsoft.AspNet.Identity.Owin.IdentityFactoryProvider`1.Dispose(Microsoft.AspNet.Identity.Owin.IdentityFactoryOptions{`0},`0)">
  90. <summary>
  91. Calls the OnDispose delegate
  92. </summary>
  93. <param name="options"></param>
  94. <param name="instance"></param>
  95. </member>
  96. <member name="P:Microsoft.AspNet.Identity.Owin.IdentityFactoryProvider`1.OnCreate">
  97. <summary>
  98. A delegate assigned to this property will be invoked when the related method is called
  99. </summary>
  100. </member>
  101. <member name="P:Microsoft.AspNet.Identity.Owin.IdentityFactoryProvider`1.OnDispose">
  102. <summary>
  103. A delegate assigned to this property will be invoked when the related method is called
  104. </summary>
  105. </member>
  106. <member name="T:Microsoft.AspNet.Identity.Owin.DataProtectorTokenProvider`1">
  107. <summary>
  108. Token provider that uses an IDataProtector to generate encrypted tokens based off of the security stamp
  109. </summary>
  110. </member>
  111. <member name="T:Microsoft.AspNet.Identity.Owin.DataProtectorTokenProvider`2">
  112. <summary>
  113. Token provider that uses an IDataProtector to generate encrypted tokens based off of the security stamp
  114. </summary>
  115. </member>
  116. <member name="M:Microsoft.AspNet.Identity.Owin.DataProtectorTokenProvider`2.#ctor(Microsoft.Owin.Security.DataProtection.IDataProtector)">
  117. <summary>
  118. Constructor
  119. </summary>
  120. <param name="protector"></param>
  121. </member>
  122. <member name="M:Microsoft.AspNet.Identity.Owin.DataProtectorTokenProvider`2.GenerateAsync(System.String,Microsoft.AspNet.Identity.UserManager{`0,`1},`0)">
  123. <summary>
  124. Generate a protected string for a user
  125. </summary>
  126. <param name="purpose"></param>
  127. <param name="manager"></param>
  128. <param name="user"></param>
  129. <returns></returns>
  130. </member>
  131. <member name="M:Microsoft.AspNet.Identity.Owin.DataProtectorTokenProvider`2.ValidateAsync(System.String,System.String,Microsoft.AspNet.Identity.UserManager{`0,`1},`0)">
  132. <summary>
  133. Return false if the token is not valid
  134. </summary>
  135. <param name="purpose"></param>
  136. <param name="token"></param>
  137. <param name="manager"></param>
  138. <param name="user"></param>
  139. <returns></returns>
  140. </member>
  141. <member name="M:Microsoft.AspNet.Identity.Owin.DataProtectorTokenProvider`2.IsValidProviderForUserAsync(Microsoft.AspNet.Identity.UserManager{`0,`1},`0)">
  142. <summary>
  143. Returns true if the provider can be used to generate tokens for this user
  144. </summary>
  145. <param name="manager"></param>
  146. <param name="user"></param>
  147. <returns></returns>
  148. </member>
  149. <member name="M:Microsoft.AspNet.Identity.Owin.DataProtectorTokenProvider`2.NotifyAsync(System.String,Microsoft.AspNet.Identity.UserManager{`0,`1},`0)">
  150. <summary>
  151. This provider no-ops by default when asked to notify a user
  152. </summary>
  153. <param name="token"></param>
  154. <param name="manager"></param>
  155. <param name="user"></param>
  156. <returns></returns>
  157. </member>
  158. <member name="P:Microsoft.AspNet.Identity.Owin.DataProtectorTokenProvider`2.Protector">
  159. <summary>
  160. IDataProtector for the token
  161. </summary>
  162. </member>
  163. <member name="P:Microsoft.AspNet.Identity.Owin.DataProtectorTokenProvider`2.TokenLifespan">
  164. <summary>
  165. Lifespan after which the token is considered expired
  166. </summary>
  167. </member>
  168. <member name="M:Microsoft.AspNet.Identity.Owin.DataProtectorTokenProvider`1.#ctor(Microsoft.Owin.Security.DataProtection.IDataProtector)">
  169. <summary>
  170. Constructor
  171. </summary>
  172. <param name="protector"></param>
  173. </member>
  174. <member name="T:Owin.AppBuilderExtensions">
  175. <summary>
  176. Extensions off of IAppBuilder to make it easier to configure the SignInCookies
  177. </summary>
  178. </member>
  179. <member name="M:Owin.AppBuilderExtensions.CreatePerOwinContext``1(Owin.IAppBuilder,System.Func{``0})">
  180. <summary>
  181. Registers a callback that will be invoked to create an instance of type T that will be stored in the OwinContext
  182. which can fetched via context.Get
  183. </summary>
  184. <typeparam name="T"></typeparam>
  185. <param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
  186. <param name="createCallback">Invoked to create an instance of T</param>
  187. <returns>The updated <see cref="T:Owin.IAppBuilder"/></returns>
  188. </member>
  189. <member name="M:Owin.AppBuilderExtensions.CreatePerOwinContext``1(Owin.IAppBuilder,System.Func{Microsoft.AspNet.Identity.Owin.IdentityFactoryOptions{``0},Microsoft.Owin.IOwinContext,``0})">
  190. <summary>
  191. Registers a callback that will be invoked to create an instance of type T that will be stored in the OwinContext
  192. which can fetched via context.Get
  193. </summary>
  194. <typeparam name="T"></typeparam>
  195. <param name="app"></param>
  196. <param name="createCallback"></param>
  197. <returns></returns>
  198. </member>
  199. <member name="M:Owin.AppBuilderExtensions.UseExternalSignInCookie(Owin.IAppBuilder)">
  200. <summary>
  201. Configure the app to use owin middleware based cookie authentication for external identities
  202. </summary>
  203. <param name="app"></param>
  204. </member>
  205. <member name="M:Owin.AppBuilderExtensions.UseExternalSignInCookie(Owin.IAppBuilder,System.String)">
  206. <summary>
  207. Configure the app to use owin middleware based cookie authentication for external identities
  208. </summary>
  209. <param name="app"></param>
  210. <param name="externalAuthenticationType"></param>
  211. </member>
  212. <member name="M:Owin.AppBuilderExtensions.UseTwoFactorSignInCookie(Owin.IAppBuilder,System.String,System.TimeSpan)">
  213. <summary>
  214. Configures a cookie intended to be used to store the partial credentials for two factor authentication
  215. </summary>
  216. <param name="app"></param>
  217. <param name="authenticationType"></param>
  218. <param name="expires"></param>
  219. </member>
  220. <member name="M:Owin.AppBuilderExtensions.UseTwoFactorRememberBrowserCookie(Owin.IAppBuilder,System.String)">
  221. <summary>
  222. Configures a cookie intended to be used to store whether two factor authentication has been done already
  223. </summary>
  224. <param name="app"></param>
  225. <param name="authenticationType"></param>
  226. </member>
  227. <member name="M:Owin.AppBuilderExtensions.UseOAuthBearerTokens(Owin.IAppBuilder,Microsoft.Owin.Security.OAuth.OAuthAuthorizationServerOptions)">
  228. <summary>
  229. Configure the app to use owin middleware based oauth bearer tokens
  230. </summary>
  231. <param name="app"></param>
  232. <param name="options"></param>
  233. </member>
  234. <member name="T:Microsoft.Owin.Security.AuthenticationManagerExtensions">
  235. <summary>
  236. Extensions methods on IAuthenticationManager that add methods for using the default Application and External
  237. authentication type constants
  238. </summary>
  239. </member>
  240. <member name="M:Microsoft.Owin.Security.AuthenticationManagerExtensions.GetExternalAuthenticationTypes(Microsoft.Owin.Security.IAuthenticationManager)">
  241. <summary>
  242. Return the authentication types which are considered external because they have captions
  243. </summary>
  244. <param name="manager"></param>
  245. <returns></returns>
  246. </member>
  247. <member name="M:Microsoft.Owin.Security.AuthenticationManagerExtensions.GetExternalIdentityAsync(Microsoft.Owin.Security.IAuthenticationManager,System.String)">
  248. <summary>
  249. Return the identity associated with the default external authentication type
  250. </summary>
  251. <returns></returns>
  252. </member>
  253. <member name="M:Microsoft.Owin.Security.AuthenticationManagerExtensions.GetExternalLoginInfoAsync(Microsoft.Owin.Security.IAuthenticationManager)">
  254. <summary>
  255. Extracts login info out of an external identity
  256. </summary>
  257. <param name="manager"></param>
  258. <returns></returns>
  259. </member>
  260. <member name="M:Microsoft.Owin.Security.AuthenticationManagerExtensions.GetExternalLoginInfo(Microsoft.Owin.Security.IAuthenticationManager)">
  261. <summary>
  262. Extracts login info out of an external identity
  263. </summary>
  264. <param name="manager"></param>
  265. <returns></returns>
  266. </member>
  267. <member name="M:Microsoft.Owin.Security.AuthenticationManagerExtensions.GetExternalLoginInfo(Microsoft.Owin.Security.IAuthenticationManager,System.String,System.String)">
  268. <summary>
  269. Extracts login info out of an external identity
  270. </summary>
  271. <param name="manager"></param>
  272. <param name="xsrfKey">key that will be used to find the userId to verify</param>
  273. <param name="expectedValue">
  274. the value expected to be found using the xsrfKey in the AuthenticationResult.Properties
  275. dictionary
  276. </param>
  277. <returns></returns>
  278. </member>
  279. <member name="M:Microsoft.Owin.Security.AuthenticationManagerExtensions.GetExternalLoginInfoAsync(Microsoft.Owin.Security.IAuthenticationManager,System.String,System.String)">
  280. <summary>
  281. Extracts login info out of an external identity
  282. </summary>
  283. <param name="manager"></param>
  284. <param name="xsrfKey">key that will be used to find the userId to verify</param>
  285. <param name="expectedValue">
  286. the value expected to be found using the xsrfKey in the AuthenticationResult.Properties
  287. dictionary
  288. </param>
  289. <returns></returns>
  290. </member>
  291. <member name="M:Microsoft.Owin.Security.AuthenticationManagerExtensions.TwoFactorBrowserRememberedAsync(Microsoft.Owin.Security.IAuthenticationManager,System.String)">
  292. <summary>
  293. Returns true if there is a TwoFactorRememberBrowser cookie for a user
  294. </summary>
  295. <param name="manager"></param>
  296. <param name="userId"></param>
  297. <returns></returns>
  298. </member>
  299. <member name="M:Microsoft.Owin.Security.AuthenticationManagerExtensions.CreateTwoFactorRememberBrowserIdentity(Microsoft.Owin.Security.IAuthenticationManager,System.String)">
  300. <summary>
  301. Creates a TwoFactorRememberBrowser cookie for a user
  302. </summary>
  303. <param name="manager"></param>
  304. <param name="userId"></param>
  305. <returns></returns>
  306. </member>
  307. <member name="T:Microsoft.AspNet.Identity.Owin.OwinContextExtensions">
  308. <summary>
  309. Extension methods for OwinContext/>
  310. </summary>
  311. </member>
  312. <member name="M:Microsoft.AspNet.Identity.Owin.OwinContextExtensions.Set``1(Microsoft.Owin.IOwinContext,``0)">
  313. <summary>
  314. Stores an object in the OwinContext using a key based on the AssemblyQualified type name
  315. </summary>
  316. <typeparam name="T"></typeparam>
  317. <param name="context"></param>
  318. <param name="value"></param>
  319. <returns></returns>
  320. </member>
  321. <member name="M:Microsoft.AspNet.Identity.Owin.OwinContextExtensions.Get``1(Microsoft.Owin.IOwinContext)">
  322. <summary>
  323. Retrieves an object from the OwinContext using a key based on the AssemblyQualified type name
  324. </summary>
  325. <typeparam name="T"></typeparam>
  326. <param name="context"></param>
  327. <returns></returns>
  328. </member>
  329. <member name="M:Microsoft.AspNet.Identity.Owin.OwinContextExtensions.GetUserManager``1(Microsoft.Owin.IOwinContext)">
  330. <summary>
  331. Get the user manager from the context
  332. </summary>
  333. <typeparam name="TManager"></typeparam>
  334. <param name="context"></param>
  335. <returns></returns>
  336. </member>
  337. <member name="T:Microsoft.AspNet.Identity.Owin.ExternalLoginInfo">
  338. <summary>
  339. Used to return information needed to associate an external login
  340. </summary>
  341. </member>
  342. <member name="P:Microsoft.AspNet.Identity.Owin.ExternalLoginInfo.Login">
  343. <summary>
  344. Associated login data
  345. </summary>
  346. </member>
  347. <member name="P:Microsoft.AspNet.Identity.Owin.ExternalLoginInfo.DefaultUserName">
  348. <summary>
  349. Suggested user name for a user
  350. </summary>
  351. </member>
  352. <member name="P:Microsoft.AspNet.Identity.Owin.ExternalLoginInfo.Email">
  353. <summary>
  354. Email claim from the external identity
  355. </summary>
  356. </member>
  357. <member name="P:Microsoft.AspNet.Identity.Owin.ExternalLoginInfo.ExternalIdentity">
  358. <summary>
  359. The external identity
  360. </summary>
  361. </member>
  362. <member name="T:Microsoft.AspNet.Identity.Owin.SecurityStampValidator">
  363. <summary>
  364. Static helper class used to configure a CookieAuthenticationProvider to validate a cookie against a user's security
  365. stamp
  366. </summary>
  367. </member>
  368. <member name="M:Microsoft.AspNet.Identity.Owin.SecurityStampValidator.OnValidateIdentity``2(System.TimeSpan,System.Func{``0,``1,System.Threading.Tasks.Task{System.Security.Claims.ClaimsIdentity}})">
  369. <summary>
  370. Can be used as the ValidateIdentity method for a CookieAuthenticationProvider which will check a user's security
  371. stamp after validateInterval
  372. Rejects the identity if the stamp changes, and otherwise will call regenerateIdentity to sign in a new
  373. ClaimsIdentity
  374. </summary>
  375. <typeparam name="TManager"></typeparam>
  376. <typeparam name="TUser"></typeparam>
  377. <param name="validateInterval"></param>
  378. <param name="regenerateIdentity"></param>
  379. <returns></returns>
  380. </member>
  381. <member name="M:Microsoft.AspNet.Identity.Owin.SecurityStampValidator.OnValidateIdentity``3(System.TimeSpan,System.Func{``0,``1,System.Threading.Tasks.Task{System.Security.Claims.ClaimsIdentity}},System.Func{System.Security.Claims.ClaimsIdentity,``2})">
  382. <summary>
  383. Can be used as the ValidateIdentity method for a CookieAuthenticationProvider which will check a user's security
  384. stamp after validateInterval
  385. Rejects the identity if the stamp changes, and otherwise will call regenerateIdentity to sign in a new
  386. ClaimsIdentity
  387. </summary>
  388. <typeparam name="TManager"></typeparam>
  389. <typeparam name="TUser"></typeparam>
  390. <typeparam name="TKey"></typeparam>
  391. <param name="validateInterval"></param>
  392. <param name="regenerateIdentityCallback"></param>
  393. <param name="getUserIdCallback"></param>
  394. <returns></returns>
  395. </member>
  396. </members>
  397. </doc>