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.

378 lines
21 KiB

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