Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

AuthorizationEndpointConventionBuilderExtensions.RequireAuthorization Method

Definition

Namespace:
Microsoft.AspNetCore.Builder
Assembly:
Microsoft.AspNetCore.Authorization.Policy.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name Description
RequireAuthorization<TBuilder>(TBuilder)

Adds the default authorization policy to the endpoint(s).
RequireAuthorization<TBuilder>(TBuilder, AuthorizationPolicy)

Adds an authorization policy to the endpoint(s).
RequireAuthorization<TBuilder>(TBuilder, IAuthorizeData[])

Adds authorization policies with the specified IAuthorizeData to the endpoint(s).
RequireAuthorization<TBuilder>(TBuilder, Action<AuthorizationPolicyBuilder>)

Adds an new authorization policy configured by a callback to the endpoint(s).
RequireAuthorization<TBuilder>(TBuilder, String[])

Adds authorization policies with the specified names to the endpoint(s).

RequireAuthorization<TBuilder>(TBuilder)

Source:
AuthorizationEndpointConventionBuilderExtensions.cs

Adds the default authorization policy to the endpoint(s).

public:
generic <typename TBuilder>
 where TBuilder : Microsoft::AspNetCore::Builder::IEndpointConventionBuilder[System::Runtime::CompilerServices::Extension]
 static TBuilder RequireAuthorization(TBuilder builder);
public static TBuilder RequireAuthorization<TBuilder>(this TBuilder builder) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member RequireAuthorization : 'Builder -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function RequireAuthorization(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder) As TBuilder

Type Parameters

TBuilder

Parameters

builder
TBuilder

The endpoint convention builder.

Returns

TBuilder

The original convention builder parameter.

Applies to

RequireAuthorization<TBuilder>(TBuilder, AuthorizationPolicy)

Source:
AuthorizationEndpointConventionBuilderExtensions.cs

Adds an authorization policy to the endpoint(s).

public static TBuilder RequireAuthorization<TBuilder>(this TBuilder builder, Microsoft.AspNetCore.Authorization.AuthorizationPolicy policy) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member RequireAuthorization : 'Builder * Microsoft.AspNetCore.Authorization.AuthorizationPolicy -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function RequireAuthorization(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, policy As AuthorizationPolicy) As TBuilder

Type Parameters

TBuilder

Parameters

builder
TBuilder

The endpoint convention builder.

Returns

TBuilder

The original convention builder parameter.

Applies to

RequireAuthorization<TBuilder>(TBuilder, IAuthorizeData[])

Source:
AuthorizationEndpointConventionBuilderExtensions.cs

Adds authorization policies with the specified IAuthorizeData to the endpoint(s).

public:
generic <typename TBuilder>
 where TBuilder : Microsoft::AspNetCore::Builder::IEndpointConventionBuilder[System::Runtime::CompilerServices::Extension]
 static TBuilder RequireAuthorization(TBuilder builder, ... cli::array <Microsoft::AspNetCore::Authorization::IAuthorizeData ^> ^ authorizeData);
public static TBuilder RequireAuthorization<TBuilder>(this TBuilder builder, params Microsoft.AspNetCore.Authorization.IAuthorizeData[] authorizeData) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member RequireAuthorization : 'Builder * Microsoft.AspNetCore.Authorization.IAuthorizeData[] -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function RequireAuthorization(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, ParamArray authorizeData As IAuthorizeData()) As TBuilder

Type Parameters

TBuilder

Parameters

builder
TBuilder

The endpoint convention builder.

authorizeData
IAuthorizeData[]

A collection of authorizeData. If empty, the default authorization policy will be used.

Returns

TBuilder

The original convention builder parameter.

Applies to

RequireAuthorization<TBuilder>(TBuilder, Action<AuthorizationPolicyBuilder>)

Source:
AuthorizationEndpointConventionBuilderExtensions.cs

Adds an new authorization policy configured by a callback to the endpoint(s).

public static TBuilder RequireAuthorization<TBuilder>(this TBuilder builder, Action<Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder> configurePolicy) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member RequireAuthorization : 'Builder * Action<Microsoft.AspNetCore.Authorization.AuthorizationPolicyBuilder> -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function RequireAuthorization(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, configurePolicy As Action(Of AuthorizationPolicyBuilder)) As TBuilder

Type Parameters

TBuilder

Parameters

builder
TBuilder

The endpoint convention builder.

configurePolicy
Action<AuthorizationPolicyBuilder>

The callback used to configure the policy.

Returns

TBuilder

The original convention builder parameter.

Applies to

RequireAuthorization<TBuilder>(TBuilder, String[])

Source:
AuthorizationEndpointConventionBuilderExtensions.cs

Adds authorization policies with the specified names to the endpoint(s).

public:
generic <typename TBuilder>
 where TBuilder : Microsoft::AspNetCore::Builder::IEndpointConventionBuilder[System::Runtime::CompilerServices::Extension]
 static TBuilder RequireAuthorization(TBuilder builder, ... cli::array <System::String ^> ^ policyNames);
public static TBuilder RequireAuthorization<TBuilder>(this TBuilder builder, params string[] policyNames) where TBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder;
static member RequireAuthorization : 'Builder * string[] -> 'Builder (requires 'Builder :> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder)
<Extension()>
Public Function RequireAuthorization(Of TBuilder As IEndpointConventionBuilder) (builder As TBuilder, ParamArray policyNames As String()) As TBuilder

Type Parameters

TBuilder

Parameters

builder
TBuilder

The endpoint convention builder.

policyNames
String[]

A collection of policy names. If empty, the default authorization policy will be used.

Returns

TBuilder

The original convention builder parameter.

Applies to

Feedback

Was this page helpful?