Reference

JwtDefaults

Package Trax.Api.Auth.JwtNamespace Trax.Api.Auth.JwtSource JwtDefaults.cs

NO WARRANTY. Trax auth is plumbing, not a security product. You are solely responsible for securing systems that use it. See API Security.

The constants of the Trax JWT bearer scheme that AddTraxJwtAuth registers, and of the dispatcher AddTraxJwtDispatcher registers.

Signature

public static class JwtDefaults
{
    public const string SchemeName = "TraxJwt";
    public const string PolicyName = "JwtPolicy";
    public const string PrincipalType = "jwt";
    public const string DispatcherSchemeName = "TraxJwtDispatcher";
    public const string RejectSchemeName = "TraxJwtReject";
}

Members

ConstantValueDescription
SchemeNameTraxJwtThe scheme name AddTraxJwtAuth registers when no scheme name is passed.
PolicyNameJwtPolicyThe policy registered with the default scheme, satisfied only by a caller that scheme authenticated.
PrincipalTypejwtThe trax:principal-type claim DefaultJwtPrincipalResolver writes.
DispatcherSchemeNameTraxJwtDispatcherThe policy scheme AddTraxJwtDispatcher registers unless WithSchemeName names another.
RejectSchemeNameTraxJwtRejectThe scheme the dispatcher forwards to when no mapping matches and no fallback is set. It fails every request, and its challenge is a 401.

Behavior

A named scheme's policy is the scheme name followed by -JwtPolicy: the scheme cognito registers cognito-JwtPolicy, and the dispatcher TraxJwtDispatcher-JwtPolicy. A named scheme's policy is satisfied only by that scheme; the dispatcher's by any scheme it maps to, or its fallback.

Example

app.MapGet("/me", () => Results.Ok()).RequireAuthorization(JwtDefaults.PolicyName);

See also