FormioAuth

@tsed/formio

Usage

import { FormioAuth } from "@tsed/formio";

See /packages/third-parties/formio/src/types/domain/FormioAuth.ts.

Overview

interface FormioAuth {
    currentUser(req: Req, res: Res, next: Function): void;
    isTokenAllowed(req: Req, decoded: FormioDecodedToken): boolean;
    getToken(payload: FormioPayloadToken): string | boolean;
    getTempToken(req: Req, res: Res, allow: boolean, expire: number, admin: boolean, cb: Function): void;
    tempToken(req: Req, res: Res): void;
    authenticate(req: Req, forms: FormioForm | FormioForm[], userField: string, passField: string, username: string, password: string, next: Function): void;
    logout(req: Req, res: Res, next: Next): void;
}

currentUser

currentUser(req: Req, res: Res, next: Function): void;

Send the current user.

isTokenAllowed

isTokenAllowed(req: Req, decoded: FormioDecodedToken): boolean;

Checks to see if a decoded token is allowed to access this path.

getToken

getToken(payload: FormioPayloadToken): string | boolean;

Generate our JWT with the given payload, and pass it to the given callback function.

The decoded JWT.

The JWT from the given payload, or false if the jwt payload is still valid.

getTempToken

getTempToken(req: Req, res: Res, allow: boolean, expire: number, admin: boolean, cb: Function): void;

Generate a temporary token for a specific path and expiration.

tempToken

tempToken(req: Req, res: Res): void;

authenticate

authenticate(req: Req, forms: FormioForm | FormioForm[], userField: string, passField: string, username: string, password: string, next: Function): void;

Authenticate a user.

A single form or an array of forms to authenticate against. The user submission field that contains the username. The user submission field that contains the password. The user submission username to login with. The user submission password to login with. The callback function to call after authentication.

logout

logout(req: Req, res: Res, next: Next): void;

Interception logout request.