projects / platform / core / dotnet / build-tools.git / blob
? search:


68ba158c028a88c52bd1734e9897e4615f3e4f8e
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.AspNetCore.Authorization.Policy</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.AspNetCore.Builder.AuthorizationAppBuilderExtensions">\r
8             <summary>\r
9             Extension methods to add authorization capabilities to an HTTP application pipeline.\r
10             </summary>\r
11         </member>\r
12         <member name="M:Microsoft.AspNetCore.Builder.AuthorizationAppBuilderExtensions.UseAuthorization(Microsoft.AspNetCore.Builder.IApplicationBuilder)">\r
13             <summary>\r
14             Adds the <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationMiddleware"/> to the specified <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>, which enables authorization capabilities.\r
15             </summary>\r
16             <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> to add the middleware to.</param>\r
17             <returns>A reference to this instance after the operation has completed.</returns>\r
18         </member>\r
19         <member name="T:Microsoft.AspNetCore.Builder.AuthorizationEndpointConventionBuilderExtensions">\r
20             <summary>\r
21             Authorization extension methods for <see cref="T:Microsoft.AspNetCore.Builder.IEndpointConventionBuilder"/>.\r
22             </summary>\r
23         </member>\r
24         <member name="M:Microsoft.AspNetCore.Builder.AuthorizationEndpointConventionBuilderExtensions.RequireAuthorization``1(``0)">\r
25             <summary>\r
26             Adds the default authorization policy to the endpoint(s).\r
27             </summary>\r
28             <param name="builder">The endpoint convention builder.</param>\r
29             <returns>The original convention builder parameter.</returns>\r
30         </member>\r
31         <member name="M:Microsoft.AspNetCore.Builder.AuthorizationEndpointConventionBuilderExtensions.RequireAuthorization``1(``0,System.String[])">\r
32             <summary>\r
33             Adds authorization policies with the specified names to the endpoint(s).\r
34             </summary>\r
35             <param name="builder">The endpoint convention builder.</param>\r
36             <param name="policyNames">A collection of policy names. If empty, the default authorization policy will be used.</param>\r
37             <returns>The original convention builder parameter.</returns>\r
38         </member>\r
39         <member name="M:Microsoft.AspNetCore.Builder.AuthorizationEndpointConventionBuilderExtensions.RequireAuthorization``1(``0,Microsoft.AspNetCore.Authorization.IAuthorizeData[])">\r
40             <summary>\r
41             Adds authorization policies with the specified <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizeData"/> to the endpoint(s).\r
42             </summary>\r
43             <param name="builder">The endpoint convention builder.</param>\r
44             <param name="authorizeData">\r
45             A collection of <paramref name="authorizeData"/>. If empty, the default authorization policy will be used.\r
46             </param>\r
47             <returns>The original convention builder parameter.</returns>\r
48         </member>\r
49         <member name="T:Microsoft.AspNetCore.Authorization.Policy.IPolicyEvaluator">\r
50             <summary>\r
51             Base class for authorization handlers that need to be called for a specific requirement type.\r
52             </summary>\r
53         </member>\r
54         <member name="M:Microsoft.AspNetCore.Authorization.Policy.IPolicyEvaluator.AuthenticateAsync(Microsoft.AspNetCore.Authorization.AuthorizationPolicy,Microsoft.AspNetCore.Http.HttpContext)">\r
55             <summary>\r
56             Does authentication for <see cref="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.AuthenticationSchemes"/> and sets the resulting\r
57             <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to <see cref="P:Microsoft.AspNetCore.Http.HttpContext.User"/>.  If no schemes are set, this is a no-op.\r
58             </summary>\r
59             <param name="policy">The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/>.</param>\r
60             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>\r
61             <returns><see cref="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Success(Microsoft.AspNetCore.Authentication.AuthenticationTicket)"/> unless all schemes specified by <see cref="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.AuthenticationSchemes"/> fail to authenticate.  </returns>\r
62         </member>\r
63         <member name="M:Microsoft.AspNetCore.Authorization.Policy.IPolicyEvaluator.AuthorizeAsync(Microsoft.AspNetCore.Authorization.AuthorizationPolicy,Microsoft.AspNetCore.Authentication.AuthenticateResult,Microsoft.AspNetCore.Http.HttpContext,System.Object)">\r
64             <summary>\r
65             Attempts authorization for a policy using <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationService"/>.\r
66             </summary>\r
67             <param name="policy">The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/>.</param>\r
68             <param name="authenticationResult">The result of a call to <see cref="M:Microsoft.AspNetCore.Authorization.Policy.IPolicyEvaluator.AuthenticateAsync(Microsoft.AspNetCore.Authorization.AuthorizationPolicy,Microsoft.AspNetCore.Http.HttpContext)"/>.</param>\r
69             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>\r
70             <param name="resource">\r
71             An optional resource the policy should be checked with.\r
72             If a resource is not required for policy evaluation you may pass null as the value.\r
73             </param>\r
74             <returns>Returns <see cref="M:Microsoft.AspNetCore.Authorization.Policy.PolicyAuthorizationResult.Success"/> if authorization succeeds.\r
75             Otherwise returns <see cref="M:Microsoft.AspNetCore.Authorization.Policy.PolicyAuthorizationResult.Forbid"/> if <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Succeeded"/>, otherwise\r
76             returns  <see cref="M:Microsoft.AspNetCore.Authorization.Policy.PolicyAuthorizationResult.Challenge"/></returns>\r
77         </member>\r
78         <member name="P:Microsoft.AspNetCore.Authorization.Policy.PolicyAuthorizationResult.Challenged">\r
79             <summary>\r
80             If true, means the callee should challenge and try again.\r
81             </summary>\r
82         </member>\r
83         <member name="P:Microsoft.AspNetCore.Authorization.Policy.PolicyAuthorizationResult.Forbidden">\r
84             <summary>\r
85             Authorization was forbidden.\r
86             </summary>\r
87         </member>\r
88         <member name="P:Microsoft.AspNetCore.Authorization.Policy.PolicyAuthorizationResult.Succeeded">\r
89             <summary>\r
90             Authorization was successful.\r
91             </summary>\r
92         </member>\r
93         <member name="M:Microsoft.AspNetCore.Authorization.Policy.PolicyEvaluator.#ctor(Microsoft.AspNetCore.Authorization.IAuthorizationService)">\r
94             <summary>\r
95             Constructor\r
96             </summary>\r
97             <param name="authorization">The authorization service.</param>\r
98         </member>\r
99         <member name="M:Microsoft.AspNetCore.Authorization.Policy.PolicyEvaluator.AuthenticateAsync(Microsoft.AspNetCore.Authorization.AuthorizationPolicy,Microsoft.AspNetCore.Http.HttpContext)">\r
100             <summary>\r
101             Does authentication for <see cref="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.AuthenticationSchemes"/> and sets the resulting\r
102             <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to <see cref="P:Microsoft.AspNetCore.Http.HttpContext.User"/>.  If no schemes are set, this is a no-op.\r
103             </summary>\r
104             <param name="policy">The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/>.</param>\r
105             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>\r
106             <returns><see cref="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Success(Microsoft.AspNetCore.Authentication.AuthenticationTicket)"/> unless all schemes specified by <see cref="P:Microsoft.AspNetCore.Authorization.AuthorizationPolicy.AuthenticationSchemes"/> failed to authenticate.  </returns>\r
107         </member>\r
108         <member name="M:Microsoft.AspNetCore.Authorization.Policy.PolicyEvaluator.AuthorizeAsync(Microsoft.AspNetCore.Authorization.AuthorizationPolicy,Microsoft.AspNetCore.Authentication.AuthenticateResult,Microsoft.AspNetCore.Http.HttpContext,System.Object)">\r
109             <summary>\r
110             Attempts authorization for a policy using <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizationService"/>.\r
111             </summary>\r
112             <param name="policy">The <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationPolicy"/>.</param>\r
113             <param name="authenticationResult">The result of a call to <see cref="M:Microsoft.AspNetCore.Authorization.Policy.PolicyEvaluator.AuthenticateAsync(Microsoft.AspNetCore.Authorization.AuthorizationPolicy,Microsoft.AspNetCore.Http.HttpContext)"/>.</param>\r
114             <param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>\r
115             <param name="resource">\r
116             An optional resource the policy should be checked with.\r
117             If a resource is not required for policy evaluation you may pass null as the value.\r
118             </param>\r
119             <returns>Returns <see cref="M:Microsoft.AspNetCore.Authorization.Policy.PolicyAuthorizationResult.Success"/> if authorization succeeds.\r
120             Otherwise returns <see cref="M:Microsoft.AspNetCore.Authorization.Policy.PolicyAuthorizationResult.Forbid"/> if <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Succeeded"/>, otherwise\r
121             returns  <see cref="M:Microsoft.AspNetCore.Authorization.Policy.PolicyAuthorizationResult.Challenge"/></returns>\r
122         </member>\r
123         <member name="P:Microsoft.AspNetCore.Authorization.Policy.Resources.Exception_UnableToFindServices">\r
124             <summary>Unable to find the required services. Please add all the required services by calling '{0}.{1}' inside the call to '{2}' in the application startup code.</summary>\r
125         </member>\r
126         <member name="M:Microsoft.AspNetCore.Authorization.Policy.Resources.FormatException_UnableToFindServices(System.Object,System.Object,System.Object)">\r
127             <summary>Unable to find the required services. Please add all the required services by calling '{0}.{1}' inside the call to '{2}' in the application startup code.</summary>\r
128         </member>\r
129         <member name="T:Microsoft.Extensions.DependencyInjection.PolicyServiceCollectionExtensions">\r
130             <summary>\r
131             Extension methods for setting up authorization services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.\r
132             </summary>\r
133         </member>\r
134         <member name="M:Microsoft.Extensions.DependencyInjection.PolicyServiceCollectionExtensions.AddAuthorizationPolicyEvaluator(Microsoft.Extensions.DependencyInjection.IServiceCollection)">\r
135             <summary>\r
136             Adds the authorization policy evaluator service to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. \r
137             </summary>\r
138             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>\r
139             <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>\r
140         </member>\r
141         <member name="M:Microsoft.Extensions.DependencyInjection.PolicyServiceCollectionExtensions.AddAuthorization(Microsoft.Extensions.DependencyInjection.IServiceCollection)">\r
142             <summary>\r
143             Adds authorization policy services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.\r
144             </summary>\r
145             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>\r
146             <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>\r
147         </member>\r
148         <member name="M:Microsoft.Extensions.DependencyInjection.PolicyServiceCollectionExtensions.AddAuthorization(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.Authorization.AuthorizationOptions})">\r
149             <summary>\r
150             Adds authorization policy services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. \r
151             </summary>\r
152             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>\r
153             <param name="configure">An action delegate to configure the provided <see cref="T:Microsoft.AspNetCore.Authorization.AuthorizationOptions"/>.</param>\r
154             <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>\r
155         </member>\r
156         <member name="T:Microsoft.Extensions.Internal.SecurityHelper">\r
157             <summary>\r
158             Helper code used when implementing authentication middleware\r
159             </summary>\r
160         </member>\r
161         <member name="M:Microsoft.Extensions.Internal.SecurityHelper.MergeUserPrincipal(System.Security.Claims.ClaimsPrincipal,System.Security.Claims.ClaimsPrincipal)">\r
162             <summary>\r
163             Add all ClaimsIdentities from an additional ClaimPrincipal to the ClaimsPrincipal\r
164             Merges a new claims principal, placing all new identities first, and eliminating\r
165             any empty unauthenticated identities from context.User\r
166             </summary>\r
167             <param name="existingPrincipal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> containing existing <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>\r
168             <param name="additionalPrincipal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> containing <see cref="T:System.Security.Claims.ClaimsIdentity"/> to be added.</param>\r
169         </member>\r
170     </members>\r
171 </doc>\r
Domain: Dotnet / Common;