Reference

TraxAuthClaimTypes

Package Trax.Api.AuthNamespace Trax.Api.AuthSource TraxAuthClaimTypes.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 claim types every Trax authentication scheme writes, and the name of the policy every scheme joins.

Signature

public static class TraxAuthClaimTypes
{
    public const string PrincipalId = "trax:principal-id";
    public const string PrincipalType = "trax:principal-type";
    public const string TraxAuthPolicy = "TraxAuthPolicy";
}

Members

ConstantValueDescription
PrincipalIdtrax:principal-idCarries TraxPrincipal.Id qualified by the scheme that authenticated it: {scheme}:{id}.
PrincipalTypetrax:principal-typeCarries TraxPrincipal.PrincipalType when it is set.
TraxAuthPolicyTraxAuthPolicyThe combined policy. Each AddTrax*Auth call adds its scheme to it, so it accepts a caller from any registered Trax scheme.

Behavior

The id is qualified by its scheme, so the same sub from two issuers is two principals: sub = "abc" on a JWT scheme named Customer is Customer:abc. TraxPrincipalId.Qualify computes it and refuses a scheme name containing :.

trax:principal-id is a Trax claim type rather than ClaimTypes.NameIdentifier, so it does not collide with ASP.NET Core Identity. Read it with ClaimsPrincipal.TryGetPrincipalId(out var id) or FindFirst(TraxAuthClaimTypes.PrincipalId).

Example

app.MapGet("/me", (ClaimsPrincipal user) =>
        user.TryGetPrincipalId(out var id) ? Results.Ok(id) : Results.Unauthorized())
    .RequireAuthorization(TraxAuthClaimTypes.TraxAuthPolicy);

See also