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.

357 lines
22 KiB

4 years ago
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Owin.Security.MicrosoftAccount</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Owin.MicrosoftAccountAuthenticationExtensions">
  8. <summary>
  9. Extension methods for using <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware"/>
  10. </summary>
  11. </member>
  12. <member name="M:Owin.MicrosoftAccountAuthenticationExtensions.UseMicrosoftAccountAuthentication(Owin.IAppBuilder,Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions)">
  13. <summary>
  14. Authenticate users using Microsoft Account
  15. </summary>
  16. <param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
  17. <param name="options">Middleware configuration options</param>
  18. <returns>The updated <see cref="T:Owin.IAppBuilder"/></returns>
  19. </member>
  20. <member name="M:Owin.MicrosoftAccountAuthenticationExtensions.UseMicrosoftAccountAuthentication(Owin.IAppBuilder,System.String,System.String)">
  21. <summary>
  22. Authenticate users using Microsoft Account
  23. </summary>
  24. <param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
  25. <param name="clientId">The application client ID assigned by the Microsoft authentication service</param>
  26. <param name="clientSecret">The application client secret assigned by the Microsoft authentication service</param>
  27. <returns></returns>
  28. </member>
  29. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware">
  30. <summary>
  31. OWIN middleware for authenticating users using the Microsoft Account service
  32. </summary>
  33. </member>
  34. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware.#ctor(Microsoft.Owin.OwinMiddleware,Owin.IAppBuilder,Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions)">
  35. <summary>
  36. Initializes a <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware"/>
  37. </summary>
  38. <param name="next">The next middleware in the OWIN pipeline to invoke</param>
  39. <param name="app">The OWIN application</param>
  40. <param name="options">Configuration options for the middleware</param>
  41. </member>
  42. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware.CreateHandler">
  43. <summary>
  44. Provides the <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> object for processing authentication-related requests.
  45. </summary>
  46. <returns>An <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> configured with the <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions"/> supplied to the constructor.</returns>
  47. </member>
  48. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions">
  49. <summary>
  50. Configuration options for <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware"/>
  51. </summary>
  52. </member>
  53. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.#ctor">
  54. <summary>
  55. Initializes a new <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions"/>.
  56. </summary>
  57. </member>
  58. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.BackchannelCertificateValidator">
  59. <summary>
  60. Gets or sets the a pinned certificate validator to use to validate the endpoints used
  61. in back channel communications belong to Microsoft Account.
  62. </summary>
  63. <value>
  64. The pinned certificate validator.
  65. </value>
  66. <remarks>If this property is null then the default certificate checks are performed,
  67. validating the subject name and if the signing chain is a trusted party.</remarks>
  68. </member>
  69. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.Caption">
  70. <summary>
  71. Get or sets the text that the user can display on a sign in user interface.
  72. </summary>
  73. <remarks>
  74. The default value is 'Microsoft'
  75. </remarks>
  76. </member>
  77. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.ClientId">
  78. <summary>
  79. The application client ID assigned by the Microsoft authentication service.
  80. </summary>
  81. </member>
  82. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.ClientSecret">
  83. <summary>
  84. The application client secret assigned by the Microsoft authentication service.
  85. </summary>
  86. </member>
  87. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.AuthorizationEndpoint">
  88. <summary>
  89. Gets or sets the URI where the client will be redirected to authenticate.
  90. </summary>
  91. </member>
  92. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.TokenEndpoint">
  93. <summary>
  94. Gets or sets the URI the middleware will access to exchange the OAuth token.
  95. </summary>
  96. </member>
  97. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.UserInformationEndpoint">
  98. <summary>
  99. Gets or sets the URI the middleware will access to obtain the user information.
  100. </summary>
  101. </member>
  102. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.BackchannelTimeout">
  103. <summary>
  104. Gets or sets timeout value in milliseconds for back channel communications with Microsoft.
  105. </summary>
  106. <value>
  107. The back channel timeout.
  108. </value>
  109. </member>
  110. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.BackchannelHttpHandler">
  111. <summary>
  112. The HttpMessageHandler used to communicate with Microsoft.
  113. This cannot be set at the same time as BackchannelCertificateValidator unless the value
  114. can be downcast to a WebRequestHandler.
  115. </summary>
  116. </member>
  117. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.Scope">
  118. <summary>
  119. A list of permissions to request.
  120. </summary>
  121. </member>
  122. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.CallbackPath">
  123. <summary>
  124. The request path within the application's base path where the user-agent will be returned.
  125. The middleware will process this request when it arrives.
  126. Default value is "/signin-microsoft".
  127. </summary>
  128. </member>
  129. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.SignInAsAuthenticationType">
  130. <summary>
  131. Gets or sets the name of another authentication middleware which will be responsible for actually issuing a user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.
  132. </summary>
  133. </member>
  134. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.Provider">
  135. <summary>
  136. Gets or sets the <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider"/> used to handle authentication events.
  137. </summary>
  138. </member>
  139. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.StateDataFormat">
  140. <summary>
  141. Gets or sets the type used to secure data handled by the middleware.
  142. </summary>
  143. </member>
  144. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions.CookieManager">
  145. <summary>
  146. An abstraction for reading and setting cookies during the authentication process.
  147. </summary>
  148. </member>
  149. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider">
  150. <summary>
  151. Specifies callback methods which the <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. /&gt;
  152. </summary>
  153. </member>
  154. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider.Authenticated(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext)">
  155. <summary>
  156. Invoked whenever Microsoft succesfully authenticates a user
  157. </summary>
  158. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  159. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  160. </member>
  161. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountReturnEndpointContext)">
  162. <summary>
  163. Invoked prior to the <see cref="T:System.Security.Claims.ClaimsIdentity"/> being saved in a local cookie and the browser being redirected to the originally requested URL.
  164. </summary>
  165. <param name="context"></param>
  166. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  167. </member>
  168. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext)">
  169. <summary>
  170. Called when a Challenge causes a redirect to authorize endpoint in the Microsoft middleware
  171. </summary>
  172. <param name="context">Contains redirect URI and <see cref="T:Microsoft.Owin.Security.AuthenticationProperties"/> of the challenge </param>
  173. </member>
  174. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext">
  175. <summary>
  176. Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.
  177. </summary>
  178. </member>
  179. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.#ctor(Microsoft.Owin.IOwinContext,Newtonsoft.Json.Linq.JObject,System.String,System.String,System.String)">
  180. <summary>
  181. Initializes a <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext"/>
  182. </summary>
  183. <param name="context">The OWIN environment</param>
  184. <param name="user">The JSON-serialized user</param>
  185. <param name="accessToken">The access token provided by the Microsoft authentication service</param>
  186. <param name="refreshToken">The refresh token provided by Microsoft authentication service</param>
  187. <param name="expires">Seconds until expiration</param>
  188. </member>
  189. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.User">
  190. <summary>
  191. Gets the JSON-serialized user
  192. </summary>
  193. </member>
  194. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.AccessToken">
  195. <summary>
  196. Gets the access token provided by the Microsoft authentication service
  197. </summary>
  198. </member>
  199. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.RefreshToken">
  200. <summary>
  201. Gets the refresh token provided by Microsoft authentication service
  202. </summary>
  203. </member>
  204. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.ExpiresIn">
  205. <summary>
  206. Gets the Microsoft access token expiration time
  207. </summary>
  208. </member>
  209. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.Id">
  210. <summary>
  211. Gets the Microsoft Account user ID
  212. </summary>
  213. </member>
  214. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.Name">
  215. <summary>
  216. Gets the user name
  217. </summary>
  218. </member>
  219. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.FirstName">
  220. <summary>
  221. Gets the user first name
  222. </summary>
  223. </member>
  224. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.LastName">
  225. <summary>
  226. Gets the user last name
  227. </summary>
  228. </member>
  229. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.Email">
  230. <summary>
  231. Gets the user email address
  232. </summary>
  233. </member>
  234. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.Identity">
  235. <summary>
  236. Gets the <see cref="T:System.Security.Claims.ClaimsIdentity"/> representing the user
  237. </summary>
  238. </member>
  239. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext.Properties">
  240. <summary>
  241. Gets or sets a property bag for common authentication properties
  242. </summary>
  243. </member>
  244. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider">
  245. <summary>
  246. Default <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.IMicrosoftAccountAuthenticationProvider"/> implementation.
  247. </summary>
  248. </member>
  249. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.#ctor">
  250. <summary>
  251. Initializes a new <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider"/>
  252. </summary>
  253. </member>
  254. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.Authenticated(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticatedContext)">
  255. <summary>
  256. Invoked whenever Microsoft succesfully authenticates a user
  257. </summary>
  258. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  259. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  260. </member>
  261. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountReturnEndpointContext)">
  262. <summary>
  263. Invoked prior to the <see cref="T:System.Security.Claims.ClaimsIdentity"/> being saved in a local cookie and the browser being redirected to the originally requested URL.
  264. </summary>
  265. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/></param>
  266. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  267. </member>
  268. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext)">
  269. <summary>
  270. Called when a Challenge causes a redirect to authorize endpoint in the Microsoft account middleware
  271. </summary>
  272. <param name="context">Contains redirect URI and <see cref="T:Microsoft.Owin.Security.AuthenticationProperties"/> of the challenge </param>
  273. </member>
  274. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.OnAuthenticated">
  275. <summary>
  276. Gets or sets the function that is invoked when the Authenticated method is invoked.
  277. </summary>
  278. </member>
  279. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.OnReturnEndpoint">
  280. <summary>
  281. Gets or sets the function that is invoked when the ReturnEndpoint method is invoked.
  282. </summary>
  283. </member>
  284. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationProvider.OnApplyRedirect">
  285. <summary>
  286. Gets or sets the delegate that is invoked when the ApplyRedirect method is invoked.
  287. </summary>
  288. </member>
  289. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountReturnEndpointContext">
  290. <summary>
  291. Provides context information to middleware providers.
  292. </summary>
  293. </member>
  294. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountReturnEndpointContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.AuthenticationTicket)">
  295. <summary>
  296. Initializes a new <see cref="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountReturnEndpointContext"/>.
  297. </summary>
  298. <param name="context">OWIN environment</param>
  299. <param name="ticket">The authentication ticket</param>
  300. </member>
  301. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext">
  302. <summary>
  303. Context passed when a Challenge causes a redirect to authorize endpoint in the Microsoft account middleware
  304. </summary>
  305. </member>
  306. <member name="M:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountAuthenticationOptions,Microsoft.Owin.Security.AuthenticationProperties,System.String)">
  307. <summary>
  308. Creates a new context object.
  309. </summary>
  310. <param name="context">The OWIN request context</param>
  311. <param name="options">The Microsoft account middleware options</param>
  312. <param name="properties">The authenticaiton properties of the challenge</param>
  313. <param name="redirectUri">The initial redirect URI</param>
  314. </member>
  315. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext.RedirectUri">
  316. <summary>
  317. Gets the URI used for the redirect operation.
  318. </summary>
  319. </member>
  320. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.MicrosoftAccountApplyRedirectContext.Properties">
  321. <summary>
  322. Gets the authenticaiton properties of the challenge
  323. </summary>
  324. </member>
  325. <member name="T:Microsoft.Owin.Security.MicrosoftAccount.Resources">
  326. <summary>
  327. A strongly-typed resource class, for looking up localized strings, etc.
  328. </summary>
  329. </member>
  330. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.Resources.ResourceManager">
  331. <summary>
  332. Returns the cached ResourceManager instance used by this class.
  333. </summary>
  334. </member>
  335. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.Resources.Culture">
  336. <summary>
  337. Overrides the current thread's CurrentUICulture property for all
  338. resource lookups using this strongly typed resource class.
  339. </summary>
  340. </member>
  341. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.Resources.Exception_MissingId">
  342. <summary>
  343. Looks up a localized string similar to The user does not have an id..
  344. </summary>
  345. </member>
  346. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.Resources.Exception_OptionMustBeProvided">
  347. <summary>
  348. Looks up a localized string similar to The &apos;{0}&apos; option must be provided..
  349. </summary>
  350. </member>
  351. <member name="P:Microsoft.Owin.Security.MicrosoftAccount.Resources.Exception_ValidatorHandlerMismatch">
  352. <summary>
  353. Looks up a localized string similar to An ICertificateValidator cannot be specified at the same time as an HttpMessageHandler unless it is a WebRequestHandler..
  354. </summary>
  355. </member>
  356. </members>
  357. </doc>