Language

RolesRequiredHttpContextExtensions.ValidateAppRole Method

Definition

When applied to an HttpContext, verifies that the current principal has one of the expected role values. This validates a role claim and value, not whether the caller is an application.

public static void ValidateAppRole(this Microsoft.AspNetCore.Http.HttpContext context, params string[] acceptedRoles);
static member ValidateAppRole : Microsoft.AspNetCore.Http.HttpContext * string[] -> unit
<Extension()>
Public Sub ValidateAppRole (context As HttpContext, ParamArray acceptedRoles As String())

Parameters

context
HttpContext

HttpContext (from the controller).

acceptedRoles
String[]

Roles accepted by this web API.

Remarks

When the roles don't match, the response is a 403 (Forbidden), because the principal does not have the expected roles.

Applies to