Stone.js API
    Preparing search index...

    Interface AuthDecoratorOptions

    Options for the @Auth decorator: the stone.auth bucket, every key optional.

    interface AuthDecoratorOptions {
        algorithm?: string;
        algorithms?: string[];
        audience?: string | string[];
        clockTolerance?: string | number;
        expiresIn?: string | number;
        issuer?: string;
        jwksUri?: string;
        privateKey?: string;
        publicKey?: string;
        resolveUser?: (claims: JwtClaims) => unknown;
        secret?: string;
    }

    Hierarchy (View Summary)

    Index
    algorithm? algorithms? audience? clockTolerance? expiresIn? issuer? jwksUri? privateKey? publicKey? resolveUser? secret?
    algorithm?: string

    Default signing algorithm (default HS256).

    algorithms?: string[]

    Accepted verification algorithms.

    audience?: string | string[]

    Default audience stamped on and expected in tokens.

    clockTolerance?: string | number

    Clock skew tolerance for verification.

    expiresIn?: string | number

    Default token lifetime (default '1h').

    issuer?: string

    Default issuer stamped on and expected in tokens.

    jwksUri?: string

    Remote JWKS endpoint for verification (OAuth/OIDC).

    privateKey?: string

    PEM private key for asymmetric signing (RS/ES/PS).

    publicKey?: string

    PEM public key for asymmetric verification.

    resolveUser?: (claims: JwtClaims) => unknown

    Maps verified claims into the application principal attached to the event.

    May be asynchronous: resolving a principal usually hits a store (the token subject has to become your user, and that first lookup often provisions the account).

    secret?: string

    Shared secret for HMAC (HS256/384/512).

    Settings
    Member Visibility

    On This Page
    Properties