Microsoft.AspNetCore.Authorization.xml 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.AspNetCore.Authorization</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.AspNetCore.Authorization.AllowAnonymousAttribute">
  8. <summary>
  9. Specifies that the class or method that this attribute is applied to does not require authorization.
  10. </summary>
  11. </member>
  12. <member name="T:Microsoft.AspNetCore.Authorization.AuthorizationFailure">
  13. <summary>
  14. Encapsulates a failure result of <see cref="M:Microsoft.AspNetCore.Authorization.IAuthorizationService.AuthorizeAsync(System.Security.Claims.ClaimsPrincipal,System.Object,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizationRequirement})"/>.
  15. </summary>
  16. </member>
  17. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationFailure.FailCalled">
  18. <summary>
  19. Failure was due to <see cref="M:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.Fail"/> being called.
  20. </summary>
  21. </member>
  22. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationFailure.FailedRequirements">
  23. <summary>
  24. Failure was due to these requirements not being met via <see cref="M:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.Succeed(Microsoft.AspNetCore.Authorization.IAuthorizationRequirement)"/>.
  25. </summary>
  26. </member>
  27. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationFailure.ExplicitFail">
  28. <summary>
  29. Return a failure due to <see cref="M:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.Fail"/> being called.
  30. </summary>
  31. <returns>The failure.</returns>
  32. </member>
  33. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationFailure.Failed(System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizationRequirement})">
  34. <summary>
  35. Return a failure due to some requirements not being met via <see cref="M:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.Succeed(Microsoft.AspNetCore.Authorization.IAuthorizationRequirement)"/>.
  36. </summary>
  37. <param name="failed">The requirements that were not met.</param>
  38. <returns>The failure.</returns>
  39. </member>
  40. <member name="T:Microsoft.AspNetCore.Authorization.AuthorizationHandler`1">
  41. <summary>
  42. Base class for authorization handlers that need to be called for a specific requirement type.
  43. </summary>
  44. <typeparam name="TRequirement">The type of the requirement to handle.</typeparam>
  45. </member>
  46. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationHandler`1.HandleAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext)">
  47. <summary>
  48. Makes a decision if authorization is allowed.
  49. </summary>
  50. <param name="context">The authorization context.</param>
  51. </member>
  52. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationHandler`1.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,`0)">
  53. <summary>
  54. Makes a decision if authorization is allowed based on a specific requirement.
  55. </summary>
  56. <param name="context">The authorization context.</param>
  57. <param name="requirement">The requirement to evaluate.</param>
  58. </member>
  59. <member name="T:Microsoft.AspNetCore.Authorization.AuthorizationHandler`2">
  60. <summary>
  61. Base class for authorization handlers that need to be called for specific requirement and
  62. resource types.
  63. </summary>
  64. <typeparam name="TRequirement">The type of the requirement to evaluate.</typeparam>
  65. <typeparam name="TResource">The type of the resource to evaluate.</typeparam>
  66. </member>
  67. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationHandler`2.HandleAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext)">
  68. <summary>
  69. Makes a decision if authorization is allowed.
  70. </summary>
  71. <param name="context">The authorization context.</param>
  72. </member>
  73. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationHandler`2.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,`0,`1)">
  74. <summary>
  75. Makes a decision if authorization is allowed based on a specific requirement and resource.
  76. </summary>
  77. <param name="context">The authorization context.</param>
  78. <param name="requirement">The requirement to evaluate.</param>
  79. <param name="resource">The resource to evaluate.</param>
  80. </member>
  81. <member name="T:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext">
  82. <summary>
  83. Contains authorization information used by <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler"/>.
  84. </summary>
  85. </member>
  86. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.#ctor(System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizationRequirement},System.Security.Claims.ClaimsPrincipal,System.Object)">
  87. <summary>
  88. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext"/>.
  89. </summary>
  90. <param name="requirements">A collection of all the <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/> for the current authorization action.</param>
  91. <param name="user">A <see cref="T:System.Security.Claims.ClaimsPrincipal"/> representing the current user.</param>
  92. <param name="resource">An optional resource to evaluate the <paramref name="requirements"/> against.</param>
  93. </member>
  94. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.Requirements">
  95. <summary>
  96. The collection of all the <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/> for the current authorization action.
  97. </summary>
  98. </member>
  99. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.User">
  100. <summary>
  101. The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> representing the current user.
  102. </summary>
  103. </member>
  104. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.Resource">
  105. <summary>
  106. The optional resource to evaluate the <see cref="P:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.Requirements"/> against.
  107. </summary>
  108. </member>
  109. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.PendingRequirements">
  110. <summary>
  111. Gets the requirements that have not yet been marked as succeeded.
  112. </summary>
  113. </member>
  114. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.HasFailed">
  115. <summary>
  116. Flag indicating whether the current authorization processing has failed.
  117. </summary>
  118. </member>
  119. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.HasSucceeded">
  120. <summary>
  121. Flag indicating whether the current authorization processing has succeeded.
  122. </summary>
  123. </member>
  124. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.Fail">
  125. <summary>
  126. Called to indicate <see cref="P:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.HasSucceeded"/> will
  127. never return true, even if all requirements are met.
  128. </summary>
  129. </member>
  130. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext.Succeed(Microsoft.AspNetCore.Authorization.IAuthorizationRequirement)">
  131. <summary>
  132. Called to mark the specified <paramref name="requirement"/> as being
  133. successfully evaluated.
  134. </summary>
  135. <param name="requirement">The requirement whose evaluation has succeeded.</param>
  136. </member>
  137. <member name="T:Microsoft.AspNetCore.Authorization.AuthorizationOptions">
  138. <summary>
  139. Provides programmatic configuration used by <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationService"/> and <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationPolicyProvider"/>.
  140. </summary>
  141. </member>
  142. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationOptions.InvokeHandlersAfterFailure">
  143. <summary>
  144. Determines whether authentication handlers should be invoked after a failure.
  145. Defaults to true.
  146. </summary>
  147. </member>
  148. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationOptions.DefaultPolicy">
  149. <summary>
  150. Gets or sets the default authorization policy.
  151. </summary>
  152. <remarks>
  153. The default policy is to require any authenticated user.
  154. </remarks>
  155. </member>
  156. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationOptions.AddPolicy(System.String,Microsoft.AspNetCore.Authorization.AuthorizationPolicy)">
  157. <summary>
  158. Add an authorization policy with the provided name.
  159. </summary>
  160. <param name="name">The name of the policy.</param>
  161. <param name="policy">The authorization policy.</param>
  162. </member>
  163. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationOptions.AddPolicy(System.String,System.Action{Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder})">
  164. <summary>
  165. Add a policy that is built from a delegate with the provided name.
  166. </summary>
  167. <param name="name">The name of the policy.</param>
  168. <param name="configurePolicy">The delegate that will be used to build the policy.</param>
  169. </member>
  170. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationOptions.GetPolicy(System.String)">
  171. <summary>
  172. Returns the policy for the specified name, or null if a policy with the name does not exist.
  173. </summary>
  174. <param name="name">The name of the policy to return.</param>
  175. <returns>The policy for the specified name, or null if a policy with the name does not exist.</returns>
  176. </member>
  177. <member name="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy">
  178. <summary>
  179. Represents a collection of authorization requirements and the scheme or
  180. schemes they are evaluated against, all of which must succeed
  181. for authorization to succeed.
  182. </summary>
  183. </member>
  184. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.#ctor(System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizationRequirement},System.Collections.Generic.IEnumerable{System.String})">
  185. <summary>
  186. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/>.
  187. </summary>
  188. <param name="requirements">
  189. The list of <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/>s which must succeed for
  190. this policy to be successful.
  191. </param>
  192. <param name="authenticationSchemes">
  193. The authentication schemes the <paramref name="requirements"/> are evaluated against.
  194. </param>
  195. </member>
  196. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.Requirements">
  197. <summary>
  198. Gets a readonly list of <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/>s which must succeed for
  199. this policy to be successful.
  200. </summary>
  201. </member>
  202. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.AuthenticationSchemes">
  203. <summary>
  204. Gets a readonly list of the authentication schemes the <see cref="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.Requirements"/>
  205. are evaluated against.
  206. </summary>
  207. </member>
  208. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.Combine(Microsoft.AspNetCore.Authorization.AuthorizationPolicy[])">
  209. <summary>
  210. Combines the specified <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> into a single policy.
  211. </summary>
  212. <param name="policies">The authorization policies to combine.</param>
  213. <returns>
  214. A new <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> which represents the combination of the
  215. specified <paramref name="policies"/>.
  216. </returns>
  217. </member>
  218. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.Combine(System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.AuthorizationPolicy})">
  219. <summary>
  220. Combines the specified <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> into a single policy.
  221. </summary>
  222. <param name="policies">The authorization policies to combine.</param>
  223. <returns>
  224. A new <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> which represents the combination of the
  225. specified <paramref name="policies"/>.
  226. </returns>
  227. </member>
  228. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.CombineAsync(Microsoft.AspNetCore.Authorization.IAuthorizationPolicyProvider,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizeData})">
  229. <summary>
  230. Combines the <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> provided by the specified
  231. <paramref name="policyProvider"/>.
  232. </summary>
  233. <param name="policyProvider">A <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationPolicyProvider"/> which provides the policies to combine.</param>
  234. <param name="authorizeData">A collection of authorization data used to apply authorization to a resource.</param>
  235. <returns>
  236. A new <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> which represents the combination of the
  237. authorization policies provided by the specified <paramref name="policyProvider"/>.
  238. </returns>
  239. </member>
  240. <member name="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder">
  241. <summary>
  242. Used for building policies during application startup.
  243. </summary>
  244. </member>
  245. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.#ctor(System.String[])">
  246. <summary>
  247. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder"/>
  248. </summary>
  249. <param name="authenticationSchemes">An array of authentication schemes the policy should be evaluated against.</param>
  250. </member>
  251. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.#ctor(Microsoft.AspNetCore.Authorization.AuthorizationPolicy)">
  252. <summary>
  253. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder"/>.
  254. </summary>
  255. <param name="policy">The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> to build.</param>
  256. </member>
  257. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.Requirements">
  258. <summary>
  259. Gets or sets a list of <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/>s which must succeed for
  260. this policy to be successful.
  261. </summary>
  262. </member>
  263. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.AuthenticationSchemes">
  264. <summary>
  265. Gets or sets a list authentication schemes the <see cref="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.Requirements"/>
  266. are evaluated against.
  267. </summary>
  268. </member>
  269. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.AddAuthenticationSchemes(System.String[])">
  270. <summary>
  271. Adds the specified authentication <paramref name="schemes"/> to the
  272. <see cref="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.AuthenticationSchemes"/> for this instance.
  273. </summary>
  274. <param name="schemes">The schemes to add.</param>
  275. <returns>A reference to this instance after the operation has completed.</returns>
  276. </member>
  277. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.AddRequirements(Microsoft.AspNetCore.Authorization.IAuthorizationRequirement[])">
  278. <summary>
  279. Adds the specified <paramref name="requirements"/> to the
  280. <see cref="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.Requirements"/> for this instance.
  281. </summary>
  282. <param name="requirements">The authorization requirements to add.</param>
  283. <returns>A reference to this instance after the operation has completed.</returns>
  284. </member>
  285. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.Combine(Microsoft.AspNetCore.Authorization.AuthorizationPolicy)">
  286. <summary>
  287. Combines the specified <paramref name="policy"/> into the current instance.
  288. </summary>
  289. <param name="policy">The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> to combine.</param>
  290. <returns>A reference to this instance after the operation has completed.</returns>
  291. </member>
  292. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.RequireClaim(System.String,System.String[])">
  293. <summary>
  294. Adds a <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.ClaimsAuthorizationRequirement"/>
  295. to the current instance.
  296. </summary>
  297. <param name="claimType">The claim type required.</param>
  298. <param name="requiredValues">Values the claim must process one or more of for evaluation to succeed.</param>
  299. <returns>A reference to this instance after the operation has completed.</returns>
  300. </member>
  301. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.RequireClaim(System.String,System.Collections.Generic.IEnumerable{System.String})">
  302. <summary>
  303. Adds a <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.ClaimsAuthorizationRequirement"/>
  304. to the current instance.
  305. </summary>
  306. <param name="claimType">The claim type required.</param>
  307. <param name="requiredValues">Values the claim must process one or more of for evaluation to succeed.</param>
  308. <returns>A reference to this instance after the operation has completed.</returns>
  309. </member>
  310. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.RequireClaim(System.String)">
  311. <summary>
  312. Adds a <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.ClaimsAuthorizationRequirement"/>
  313. to the current instance.
  314. </summary>
  315. <param name="claimType">The claim type required, which no restrictions on claim value.</param>
  316. <returns>A reference to this instance after the operation has completed.</returns>
  317. </member>
  318. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.RequireRole(System.String[])">
  319. <summary>
  320. Adds a <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.RolesAuthorizationRequirement"/>
  321. to the current instance.
  322. </summary>
  323. <param name="roles">The roles required.</param>
  324. <returns>A reference to this instance after the operation has completed.</returns>
  325. </member>
  326. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.RequireRole(System.Collections.Generic.IEnumerable{System.String})">
  327. <summary>
  328. Adds a <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.RolesAuthorizationRequirement"/>
  329. to the current instance.
  330. </summary>
  331. <param name="roles">The roles required.</param>
  332. <returns>A reference to this instance after the operation has completed.</returns>
  333. </member>
  334. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.RequireUserName(System.String)">
  335. <summary>
  336. Adds a <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.NameAuthorizationRequirement"/>
  337. to the current instance.
  338. </summary>
  339. <param name="userName">The user name the current user must possess.</param>
  340. <returns>A reference to this instance after the operation has completed.</returns>
  341. </member>
  342. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.RequireAuthenticatedUser">
  343. <summary>
  344. Adds a <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.DenyAnonymousAuthorizationRequirement"/> to the current instance.
  345. </summary>
  346. <returns>A reference to this instance after the operation has completed.</returns>
  347. </member>
  348. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.RequireAssertion(System.Func{Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,System.Boolean})">
  349. <summary>
  350. Adds an <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.AssertionRequirement"/> to the current instance.
  351. </summary>
  352. <param name="handler">The handler to evaluate during authorization.</param>
  353. <returns>A reference to this instance after the operation has completed.</returns>
  354. </member>
  355. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.RequireAssertion(System.Func{Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,System.Threading.Tasks.Task{System.Boolean}})">
  356. <summary>
  357. Adds an <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.AssertionRequirement"/> to the current instance.
  358. </summary>
  359. <param name="handler">The handler to evaluate during authorization.</param>
  360. <returns>A reference to this instance after the operation has completed.</returns>
  361. </member>
  362. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder.Build">
  363. <summary>
  364. Builds a new <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> from the requirements
  365. in this instance.
  366. </summary>
  367. <returns>
  368. A new <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> built from the requirements in this instance.
  369. </returns>
  370. </member>
  371. <member name="T:Microsoft.AspNetCore.Authorization.AuthorizationResult">
  372. <summary>
  373. Encapsulates the result of <see cref="M:Microsoft.AspNetCore.Authorization.IAuthorizationService.AuthorizeAsync(System.Security.Claims.ClaimsPrincipal,System.Object,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizationRequirement})"/>.
  374. </summary>
  375. </member>
  376. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationResult.Succeeded">
  377. <summary>
  378. True if authorization was successful.
  379. </summary>
  380. </member>
  381. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizationResult.Failure">
  382. <summary>
  383. Contains information about why authorization failed.
  384. </summary>
  385. </member>
  386. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationResult.Success">
  387. <summary>
  388. Returns a successful result.
  389. </summary>
  390. <returns>A successful result.</returns>
  391. </member>
  392. <member name="T:Microsoft.AspNetCore.Authorization.AuthorizationServiceExtensions">
  393. <summary>
  394. Extension methods for <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationService"/>.
  395. </summary>
  396. </member>
  397. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationServiceExtensions.AuthorizeAsync(Microsoft.AspNetCore.Authorization.IAuthorizationService,System.Security.Claims.ClaimsPrincipal,System.Object,Microsoft.AspNetCore.Authorization.IAuthorizationRequirement)">
  398. <summary>
  399. Checks if a user meets a specific requirement for the specified resource
  400. </summary>
  401. <param name="service">The <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationService"/> providing authorization.</param>
  402. <param name="user">The user to evaluate the policy against.</param>
  403. <param name="resource">The resource to evaluate the policy against.</param>
  404. <param name="requirement">The requirement to evaluate the policy against.</param>
  405. <returns>
  406. A flag indicating whether requirement evaluation has succeeded or failed.
  407. This value is <value>true</value> when the user fulfills the policy, otherwise <value>false</value>.
  408. </returns>
  409. </member>
  410. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationServiceExtensions.AuthorizeAsync(Microsoft.AspNetCore.Authorization.IAuthorizationService,System.Security.Claims.ClaimsPrincipal,System.Object,Microsoft.AspNetCore.Authorization.AuthorizationPolicy)">
  411. <summary>
  412. Checks if a user meets a specific authorization policy against the specified resource.
  413. </summary>
  414. <param name="service">The <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationService"/> providing authorization.</param>
  415. <param name="user">The user to evaluate the policy against.</param>
  416. <param name="resource">The resource to evaluate the policy against.</param>
  417. <param name="policy">The policy to evaluate.</param>
  418. <returns>
  419. A flag indicating whether policy evaluation has succeeded or failed.
  420. This value is <value>true</value> when the user fulfills the policy, otherwise <value>false</value>.
  421. </returns>
  422. </member>
  423. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationServiceExtensions.AuthorizeAsync(Microsoft.AspNetCore.Authorization.IAuthorizationService,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authorization.AuthorizationPolicy)">
  424. <summary>
  425. Checks if a user meets a specific authorization policy against the specified resource.
  426. </summary>
  427. <param name="service">The <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationService"/> providing authorization.</param>
  428. <param name="user">The user to evaluate the policy against.</param>
  429. <param name="policy">The policy to evaluate.</param>
  430. <returns>
  431. A flag indicating whether policy evaluation has succeeded or failed.
  432. This value is <value>true</value> when the user fulfills the policy, otherwise <value>false</value>.
  433. </returns>
  434. </member>
  435. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizationServiceExtensions.AuthorizeAsync(Microsoft.AspNetCore.Authorization.IAuthorizationService,System.Security.Claims.ClaimsPrincipal,System.String)">
  436. <summary>
  437. Checks if a user meets a specific authorization policy against the specified resource.
  438. </summary>
  439. <param name="service">The <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationService"/> providing authorization.</param>
  440. <param name="user">The user to evaluate the policy against.</param>
  441. <param name="policyName">The name of the policy to evaluate.</param>
  442. <returns>
  443. A flag indicating whether policy evaluation has succeeded or failed.
  444. This value is <value>true</value> when the user fulfills the policy, otherwise <value>false</value>.
  445. </returns>
  446. </member>
  447. <member name="T:Microsoft.AspNetCore.Authorization.AuthorizeAttribute">
  448. <summary>
  449. Specifies that the class or method that this attribute is applied to requires the specified authorization.
  450. </summary>
  451. </member>
  452. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizeAttribute.#ctor">
  453. <summary>
  454. Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/> class.
  455. </summary>
  456. </member>
  457. <member name="M:Microsoft.AspNetCore.Authorization.AuthorizeAttribute.#ctor(System.String)">
  458. <summary>
  459. Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizeAttribute"/> class with the specified policy.
  460. </summary>
  461. <param name="policy">The name of the policy to require for authorization.</param>
  462. </member>
  463. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizeAttribute.Policy">
  464. <summary>
  465. Gets or sets the policy name that determines access to the resource.
  466. </summary>
  467. </member>
  468. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizeAttribute.Roles">
  469. <summary>
  470. Gets or sets a comma delimited list of roles that are allowed to access the resource.
  471. </summary>
  472. </member>
  473. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizeAttribute.AuthenticationSchemes">
  474. <summary>
  475. Gets or sets a comma delimited list of schemes from which user information is constructed.
  476. </summary>
  477. </member>
  478. <member name="P:Microsoft.AspNetCore.Authorization.AuthorizeAttribute.ActiveAuthenticationSchemes">
  479. <summary>
  480. Gets or sets a comma delimited list of schemes from which user information is constructed.
  481. </summary>
  482. </member>
  483. <member name="T:Microsoft.AspNetCore.Authorization.DefaultAuthorizationEvaluator">
  484. <summary>
  485. Determines whether an authorization request was successful or not.
  486. </summary>
  487. </member>
  488. <member name="M:Microsoft.AspNetCore.Authorization.DefaultAuthorizationEvaluator.Evaluate(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext)">
  489. <summary>
  490. Determines whether the authorization result was successful or not.
  491. </summary>
  492. <param name="context">The authorization information.</param>
  493. <returns>The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationResult"/>.</returns>
  494. </member>
  495. <member name="T:Microsoft.AspNetCore.Authorization.DefaultAuthorizationHandlerContextFactory">
  496. <summary>
  497. A type used to provide a <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext"/> used for authorization.
  498. </summary>
  499. </member>
  500. <member name="M:Microsoft.AspNetCore.Authorization.DefaultAuthorizationHandlerContextFactory.CreateContext(System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizationRequirement},System.Security.Claims.ClaimsPrincipal,System.Object)">
  501. <summary>
  502. Creates a <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext"/> used for authorization.
  503. </summary>
  504. <param name="requirements">The requirements to evaluate.</param>
  505. <param name="user">The user to evaluate the requirements against.</param>
  506. <param name="resource">
  507. An optional resource the policy should be checked with.
  508. If a resource is not required for policy evaluation you may pass null as the value.
  509. </param>
  510. <returns>The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext"/>.</returns>
  511. </member>
  512. <member name="T:Microsoft.AspNetCore.Authorization.DefaultAuthorizationHandlerProvider">
  513. <summary>
  514. The default implementation of a handler provider,
  515. which provides the <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler"/>s for an authorization request.
  516. </summary>
  517. </member>
  518. <member name="M:Microsoft.AspNetCore.Authorization.DefaultAuthorizationHandlerProvider.#ctor(System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizationHandler})">
  519. <summary>
  520. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.DefaultAuthorizationHandlerProvider"/>.
  521. </summary>
  522. <param name="handlers">The <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler"/>s.</param>
  523. </member>
  524. <member name="T:Microsoft.AspNetCore.Authorization.DefaultAuthorizationPolicyProvider">
  525. <summary>
  526. The default implementation of a policy provider,
  527. which provides a <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> for a particular name.
  528. </summary>
  529. </member>
  530. <member name="M:Microsoft.AspNetCore.Authorization.DefaultAuthorizationPolicyProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Authorization.AuthorizationOptions})">
  531. <summary>
  532. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.DefaultAuthorizationPolicyProvider"/>.
  533. </summary>
  534. <param name="options">The options used to configure this instance.</param>
  535. </member>
  536. <member name="M:Microsoft.AspNetCore.Authorization.DefaultAuthorizationPolicyProvider.GetDefaultPolicyAsync">
  537. <summary>
  538. Gets the default authorization policy.
  539. </summary>
  540. <returns>The default authorization policy.</returns>
  541. </member>
  542. <member name="M:Microsoft.AspNetCore.Authorization.DefaultAuthorizationPolicyProvider.GetPolicyAsync(System.String)">
  543. <summary>
  544. Gets a <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> from the given <paramref name="policyName"/>
  545. </summary>
  546. <param name="policyName">The policy name to retrieve.</param>
  547. <returns>The named <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/>.</returns>
  548. </member>
  549. <member name="T:Microsoft.AspNetCore.Authorization.DefaultAuthorizationService">
  550. <summary>
  551. The default implementation of an <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationService"/>.
  552. </summary>
  553. </member>
  554. <member name="M:Microsoft.AspNetCore.Authorization.DefaultAuthorizationService.#ctor(Microsoft.AspNetCore.Authorization.IAuthorizationPolicyProvider,Microsoft.AspNetCore.Authorization.IAuthorizationHandlerProvider,Microsoft.Extensions.Logging.ILogger{Microsoft.AspNetCore.Authorization.DefaultAuthorizationService},Microsoft.AspNetCore.Authorization.IAuthorizationHandlerContextFactory,Microsoft.AspNetCore.Authorization.IAuthorizationEvaluator,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Authorization.AuthorizationOptions})">
  555. <summary>
  556. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.DefaultAuthorizationService"/>.
  557. </summary>
  558. <param name="policyProvider">The <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationPolicyProvider"/> used to provide policies.</param>
  559. <param name="handlers">The handlers used to fulfill <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/>s.</param>
  560. <param name="logger">The logger used to log messages, warnings and errors.</param>
  561. <param name="contextFactory">The <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandlerContextFactory"/> used to create the context to handle the authorization.</param>
  562. <param name="evaluator">The <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationEvaluator"/> used to determine if authorization was successful.</param>
  563. <param name="options">The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationOptions"/> used.</param>
  564. </member>
  565. <member name="M:Microsoft.AspNetCore.Authorization.DefaultAuthorizationService.AuthorizeAsync(System.Security.Claims.ClaimsPrincipal,System.Object,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizationRequirement})">
  566. <summary>
  567. Checks if a user meets a specific set of requirements for the specified resource.
  568. </summary>
  569. <param name="user">The user to evaluate the requirements against.</param>
  570. <param name="resource">The resource to evaluate the requirements against.</param>
  571. <param name="requirements">The requirements to evaluate.</param>
  572. <returns>
  573. A flag indicating whether authorization has succeeded.
  574. This value is <value>true</value> when the user fulfills the policy otherwise <value>false</value>.
  575. </returns>
  576. </member>
  577. <member name="M:Microsoft.AspNetCore.Authorization.DefaultAuthorizationService.AuthorizeAsync(System.Security.Claims.ClaimsPrincipal,System.Object,System.String)">
  578. <summary>
  579. Checks if a user meets a specific authorization policy.
  580. </summary>
  581. <param name="user">The user to check the policy against.</param>
  582. <param name="resource">The resource the policy should be checked with.</param>
  583. <param name="policyName">The name of the policy to check against a specific context.</param>
  584. <returns>
  585. A flag indicating whether authorization has succeeded.
  586. This value is <value>true</value> when the user fulfills the policy otherwise <value>false</value>.
  587. </returns>
  588. </member>
  589. <member name="T:Microsoft.AspNetCore.Authorization.IAllowAnonymous">
  590. <summary>
  591. Marker interface to enable the <see cref="T:Microsoft.AspNetCore.Authorization.AllowAnonymousAttribute"/>.
  592. </summary>
  593. </member>
  594. <member name="T:Microsoft.AspNetCore.Authorization.IAuthorizationEvaluator">
  595. <summary>
  596. Determines whether an authorization request was successful or not.
  597. </summary>
  598. </member>
  599. <member name="M:Microsoft.AspNetCore.Authorization.IAuthorizationEvaluator.Evaluate(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext)">
  600. <summary>
  601. Determines whether the authorization result was successful or not.
  602. </summary>
  603. <param name="context">The authorization information.</param>
  604. <returns>The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationResult"/>.</returns>
  605. </member>
  606. <member name="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler">
  607. <summary>
  608. Classes implementing this interface are able to make a decision if authorization is allowed.
  609. </summary>
  610. </member>
  611. <member name="M:Microsoft.AspNetCore.Authorization.IAuthorizationHandler.HandleAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext)">
  612. <summary>
  613. Makes a decision if authorization is allowed.
  614. </summary>
  615. <param name="context">The authorization information.</param>
  616. </member>
  617. <member name="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandlerContextFactory">
  618. <summary>
  619. A type used to provide a <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext"/> used for authorization.
  620. </summary>
  621. </member>
  622. <member name="M:Microsoft.AspNetCore.Authorization.IAuthorizationHandlerContextFactory.CreateContext(System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizationRequirement},System.Security.Claims.ClaimsPrincipal,System.Object)">
  623. <summary>
  624. Creates a <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext"/> used for authorization.
  625. </summary>
  626. <param name="requirements">The requirements to evaluate.</param>
  627. <param name="user">The user to evaluate the requirements against.</param>
  628. <param name="resource">
  629. An optional resource the policy should be checked with.
  630. If a resource is not required for policy evaluation you may pass null as the value.
  631. </param>
  632. <returns>The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext"/>.</returns>
  633. </member>
  634. <member name="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandlerProvider">
  635. <summary>
  636. A type which can provide the <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler"/>s for an authorization request.
  637. </summary>
  638. </member>
  639. <member name="M:Microsoft.AspNetCore.Authorization.IAuthorizationHandlerProvider.GetHandlersAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext)">
  640. <summary>
  641. Return the handlers that will be called for the authorization request.
  642. </summary>
  643. <param name="context">The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext"/>.</param>
  644. <returns>The list of handlers.</returns>
  645. </member>
  646. <member name="T:Microsoft.AspNetCore.Authorization.IAuthorizationPolicyProvider">
  647. <summary>
  648. A type which can provide a <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> for a particular name.
  649. </summary>
  650. </member>
  651. <member name="M:Microsoft.AspNetCore.Authorization.IAuthorizationPolicyProvider.GetPolicyAsync(System.String)">
  652. <summary>
  653. Gets a <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/> from the given <paramref name="policyName"/>
  654. </summary>
  655. <param name="policyName">The policy name to retrieve.</param>
  656. <returns>The named <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/>.</returns>
  657. </member>
  658. <member name="M:Microsoft.AspNetCore.Authorization.IAuthorizationPolicyProvider.GetDefaultPolicyAsync">
  659. <summary>
  660. Gets the default authorization policy.
  661. </summary>
  662. <returns>The default authorization policy.</returns>
  663. </member>
  664. <member name="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement">
  665. <summary>
  666. Represents an authorization requirement.
  667. </summary>
  668. </member>
  669. <member name="T:Microsoft.AspNetCore.Authorization.IAuthorizationService">
  670. <summary>
  671. Checks policy based permissions for a user
  672. </summary>
  673. </member>
  674. <member name="M:Microsoft.AspNetCore.Authorization.IAuthorizationService.AuthorizeAsync(System.Security.Claims.ClaimsPrincipal,System.Object,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authorization.IAuthorizationRequirement})">
  675. <summary>
  676. Checks if a user meets a specific set of requirements for the specified resource
  677. </summary>
  678. <param name="user">The user to evaluate the requirements against.</param>
  679. <param name="resource">
  680. An optional resource the policy should be checked with.
  681. If a resource is not required for policy evaluation you may pass null as the value.
  682. </param>
  683. <param name="requirements">The requirements to evaluate.</param>
  684. <returns>
  685. A flag indicating whether authorization has succeeded.
  686. This value is <value>true</value> when the user fulfills the policy; otherwise <value>false</value>.
  687. </returns>
  688. <remarks>
  689. Resource is an optional parameter and may be null. Please ensure that you check it is not
  690. null before acting upon it.
  691. </remarks>
  692. </member>
  693. <member name="M:Microsoft.AspNetCore.Authorization.IAuthorizationService.AuthorizeAsync(System.Security.Claims.ClaimsPrincipal,System.Object,System.String)">
  694. <summary>
  695. Checks if a user meets a specific authorization policy
  696. </summary>
  697. <param name="user">The user to check the policy against.</param>
  698. <param name="resource">
  699. An optional resource the policy should be checked with.
  700. If a resource is not required for policy evaluation you may pass null as the value.
  701. </param>
  702. <param name="policyName">The name of the policy to check against a specific context.</param>
  703. <returns>
  704. A flag indicating whether authorization has succeeded.
  705. Returns a flag indicating whether the user, and optional resource has fulfilled the policy.
  706. <value>true</value> when the policy has been fulfilled; otherwise <value>false</value>.
  707. </returns>
  708. <remarks>
  709. Resource is an optional parameter and may be null. Please ensure that you check it is not
  710. null before acting upon it.
  711. </remarks>
  712. </member>
  713. <member name="T:Microsoft.AspNetCore.Authorization.IAuthorizeData">
  714. <summary>
  715. Defines the set of data required to apply authorization rules to a resource.
  716. </summary>
  717. </member>
  718. <member name="P:Microsoft.AspNetCore.Authorization.IAuthorizeData.Policy">
  719. <summary>
  720. Gets or sets the policy name that determines access to the resource.
  721. </summary>
  722. </member>
  723. <member name="P:Microsoft.AspNetCore.Authorization.IAuthorizeData.Roles">
  724. <summary>
  725. Gets or sets a comma delimited list of roles that are allowed to access the resource.
  726. </summary>
  727. </member>
  728. <member name="P:Microsoft.AspNetCore.Authorization.IAuthorizeData.AuthenticationSchemes">
  729. <summary>
  730. Gets or sets a comma delimited list of schemes from which user information is constructed.
  731. </summary>
  732. </member>
  733. <member name="T:Microsoft.AspNetCore.Authorization.Infrastructure.AssertionRequirement">
  734. <summary>
  735. Implements an <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler"/> and <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/>
  736. that takes a user specified assertion.
  737. </summary>
  738. </member>
  739. <member name="P:Microsoft.AspNetCore.Authorization.Infrastructure.AssertionRequirement.Handler">
  740. <summary>
  741. Function that is called to handle this requirement.
  742. </summary>
  743. </member>
  744. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.AssertionRequirement.#ctor(System.Func{Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,System.Boolean})">
  745. <summary>
  746. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.AssertionRequirement"/>.
  747. </summary>
  748. <param name="handler">Function that is called to handle this requirement.</param>
  749. </member>
  750. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.AssertionRequirement.#ctor(System.Func{Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,System.Threading.Tasks.Task{System.Boolean}})">
  751. <summary>
  752. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.AssertionRequirement"/>.
  753. </summary>
  754. <param name="handler">Function that is called to handle this requirement.</param>
  755. </member>
  756. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.AssertionRequirement.HandleAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext)">
  757. <summary>
  758. Calls <see cref="P:Microsoft.AspNetCore.Authorization.Infrastructure.AssertionRequirement.Handler"/> to see if authorization is allowed.
  759. </summary>
  760. <param name="context">The authorization information.</param>
  761. </member>
  762. <member name="T:Microsoft.AspNetCore.Authorization.Infrastructure.ClaimsAuthorizationRequirement">
  763. <summary>
  764. Implements an <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler"/> and <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/>
  765. which requires at least one instance of the specified claim type, and, if allowed values are specified,
  766. the claim value must be any of the allowed values.
  767. </summary>
  768. </member>
  769. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.ClaimsAuthorizationRequirement.#ctor(System.String,System.Collections.Generic.IEnumerable{System.String})">
  770. <summary>
  771. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.ClaimsAuthorizationRequirement"/>.
  772. </summary>
  773. <param name="claimType">The claim type that must be present.</param>
  774. <param name="allowedValues">The optional list of claim values, which, if present,
  775. the claim must match.</param>
  776. </member>
  777. <member name="P:Microsoft.AspNetCore.Authorization.Infrastructure.ClaimsAuthorizationRequirement.ClaimType">
  778. <summary>
  779. Gets the claim type that must be present.
  780. </summary>
  781. </member>
  782. <member name="P:Microsoft.AspNetCore.Authorization.Infrastructure.ClaimsAuthorizationRequirement.AllowedValues">
  783. <summary>
  784. Gets the optional list of claim values, which, if present,
  785. the claim must match.
  786. </summary>
  787. </member>
  788. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.ClaimsAuthorizationRequirement.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Microsoft.AspNetCore.Authorization.Infrastructure.ClaimsAuthorizationRequirement)">
  789. <summary>
  790. Makes a decision if authorization is allowed based on the claims requirements specified.
  791. </summary>
  792. <param name="context">The authorization context.</param>
  793. <param name="requirement">The requirement to evaluate.</param>
  794. </member>
  795. <member name="T:Microsoft.AspNetCore.Authorization.Infrastructure.DenyAnonymousAuthorizationRequirement">
  796. <summary>
  797. Implements an <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler"/> and <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/>
  798. which requires the current user must be authenticated.
  799. </summary>
  800. </member>
  801. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.DenyAnonymousAuthorizationRequirement.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Microsoft.AspNetCore.Authorization.Infrastructure.DenyAnonymousAuthorizationRequirement)">
  802. <summary>
  803. Makes a decision if authorization is allowed based on a specific requirement.
  804. </summary>
  805. <param name="context">The authorization context.</param>
  806. <param name="requirement">The requirement to evaluate.</param>
  807. </member>
  808. <member name="T:Microsoft.AspNetCore.Authorization.Infrastructure.NameAuthorizationRequirement">
  809. <summary>
  810. Implements an <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler"/> and <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/>
  811. which requires the current user name must match the specified value.
  812. </summary>
  813. </member>
  814. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.NameAuthorizationRequirement.#ctor(System.String)">
  815. <summary>
  816. Constructs a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.NameAuthorizationRequirement"/>.
  817. </summary>
  818. <param name="requiredName">The required name that the current user must have.</param>
  819. </member>
  820. <member name="P:Microsoft.AspNetCore.Authorization.Infrastructure.NameAuthorizationRequirement.RequiredName">
  821. <summary>
  822. Gets the required name that the current user must have.
  823. </summary>
  824. </member>
  825. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.NameAuthorizationRequirement.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Microsoft.AspNetCore.Authorization.Infrastructure.NameAuthorizationRequirement)">
  826. <summary>
  827. Makes a decision if authorization is allowed based on a specific requirement.
  828. </summary>
  829. <param name="context">The authorization context.</param>
  830. <param name="requirement">The requirement to evaluate.</param>
  831. </member>
  832. <member name="T:Microsoft.AspNetCore.Authorization.Infrastructure.OperationAuthorizationRequirement">
  833. <summary>
  834. A helper class to provide a useful <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/> which
  835. contains a name.
  836. </summary>
  837. </member>
  838. <member name="P:Microsoft.AspNetCore.Authorization.Infrastructure.OperationAuthorizationRequirement.Name">
  839. <summary>
  840. The name of this instance of <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/>.
  841. </summary>
  842. </member>
  843. <member name="T:Microsoft.AspNetCore.Authorization.Infrastructure.PassThroughAuthorizationHandler">
  844. <summary>
  845. Infrastructure class which allows an <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/> to
  846. be its own <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler"/>.
  847. </summary>
  848. </member>
  849. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.PassThroughAuthorizationHandler.HandleAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext)">
  850. <summary>
  851. Makes a decision if authorization is allowed.
  852. </summary>
  853. <param name="context">The authorization context.</param>
  854. </member>
  855. <member name="T:Microsoft.AspNetCore.Authorization.Infrastructure.RolesAuthorizationRequirement">
  856. <summary>
  857. Implements an <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationHandler"/> and <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationRequirement"/>
  858. which requires at least one role claim whose value must be any of the allowed roles.
  859. </summary>
  860. </member>
  861. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.RolesAuthorizationRequirement.#ctor(System.Collections.Generic.IEnumerable{System.String})">
  862. <summary>
  863. Creates a new instance of <see cref="T:Microsoft.AspNetCore.Authorization.Infrastructure.RolesAuthorizationRequirement"/>.
  864. </summary>
  865. <param name="allowedRoles">A collection of allowed roles.</param>
  866. </member>
  867. <member name="P:Microsoft.AspNetCore.Authorization.Infrastructure.RolesAuthorizationRequirement.AllowedRoles">
  868. <summary>
  869. Gets the collection of allowed roles.
  870. </summary>
  871. </member>
  872. <member name="M:Microsoft.AspNetCore.Authorization.Infrastructure.RolesAuthorizationRequirement.HandleRequirementAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Microsoft.AspNetCore.Authorization.Infrastructure.RolesAuthorizationRequirement)">
  873. <summary>
  874. Makes a decision if authorization is allowed based on a specific requirement.
  875. </summary>
  876. <param name="context">The authorization context.</param>
  877. <param name="requirement">The requirement to evaluate.</param>
  878. </member>
  879. <member name="P:Microsoft.AspNetCore.Authorization.Resources.Exception_AuthorizationPolicyEmpty">
  880. <summary>
  881. AuthorizationPolicy must have at least one requirement.
  882. </summary>
  883. </member>
  884. <member name="M:Microsoft.AspNetCore.Authorization.Resources.FormatException_AuthorizationPolicyEmpty">
  885. <summary>
  886. AuthorizationPolicy must have at least one requirement.
  887. </summary>
  888. </member>
  889. <member name="P:Microsoft.AspNetCore.Authorization.Resources.Exception_AuthorizationPolicyNotFound">
  890. <summary>
  891. The AuthorizationPolicy named: '{0}' was not found.
  892. </summary>
  893. </member>
  894. <member name="M:Microsoft.AspNetCore.Authorization.Resources.FormatException_AuthorizationPolicyNotFound(System.Object)">
  895. <summary>
  896. The AuthorizationPolicy named: '{0}' was not found.
  897. </summary>
  898. </member>
  899. <member name="P:Microsoft.AspNetCore.Authorization.Resources.Exception_RoleRequirementEmpty">
  900. <summary>
  901. At least one role must be specified.
  902. </summary>
  903. </member>
  904. <member name="M:Microsoft.AspNetCore.Authorization.Resources.FormatException_RoleRequirementEmpty">
  905. <summary>
  906. At least one role must be specified.
  907. </summary>
  908. </member>
  909. <member name="T:Microsoft.Extensions.DependencyInjection.AuthorizationServiceCollectionExtensions">
  910. <summary>
  911. Extension methods for setting up authorization services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  912. </summary>
  913. </member>
  914. <member name="M:Microsoft.Extensions.DependencyInjection.AuthorizationServiceCollectionExtensions.AddAuthorization(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
  915. <summary>
  916. Adds authorization services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  917. </summary>
  918. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
  919. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  920. </member>
  921. <member name="M:Microsoft.Extensions.DependencyInjection.AuthorizationServiceCollectionExtensions.AddAuthorization(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.Authorization.AuthorizationOptions})">
  922. <summary>
  923. Adds authorization services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
  924. </summary>
  925. <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
  926. <param name="configure">An action delegate to configure the provided <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationOptions"/>.</param>
  927. <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
  928. </member>
  929. </members>
  930. </doc>