Interface AuthDefaultAdapterOptions

interface AuthDefaultAdapterOptions {
    authEncSecret: string;
    authSignSecret: string;
    authType?: AuthType;
    authenticate?: AuthenticationFunction;
    authenticateRefreshToken?: AuthenticationRefreshTokenFunction;
    authorizedRedirectUrls?: string[];
    collectionNames?: AuthDefaultAdapterCollectionNames;
    cookieConfig?: false | CookieConfig;
    enableRefreshToken?: boolean;
    oauthCallbackTokenBehavior?: OauthCallbackTokenBehavior;
    setTwoFactorAuth?: false | {
        codeConfig?: {
            expireTime?: string | number;
            length?: number;
        };
        emailConfig: {
            bodyTemplate: string;
            sender: string;
            subject: string;
        };
    };
    tokenExpireTime?: TokenExpireTime;
}

Properties

authEncSecret authSignSecret authType? authenticate? authenticateRefreshToken? authorizedRedirectUrls? collectionNames? cookieConfig? enableRefreshToken? oauthCallbackTokenBehavior? setTwoFactorAuth? tokenExpireTime?

Properties

authEncSecret

authEncSecret: string

Secret use to encrypt the JWT Token

authSignSecret

authSignSecret: string

Secret use to sign the JWT Token

Optional authType

authType?: AuthType

Optional authenticate

authenticate?: AuthenticationFunction

Function that will be called to authenticate the user via validators. When not provided, this will default to the default for the given authType.

Typically you would only provide this if designing your own authentication.

Optional authenticateRefreshToken

authenticateRefreshToken?: AuthenticationRefreshTokenFunction

Function that will be called to authenticate the a refresh token. When not provided, this will default to the default for the given authType.

This is also used to fetch the refresh token without authentication when decryptToken is false.

Typically you would only provide this if designing your own authentication.

Optional authorizedRedirectUrls

authorizedRedirectUrls?: string[]

The allowed authorized redirect urls for social login

Optional collectionNames

collectionNames?: AuthDefaultAdapterCollectionNames

Collection name configuration for auth data services

Optional cookieConfig

cookieConfig?: false | CookieConfig

If authType === 'cookie', configures how the cookie is set up

Optional enableRefreshToken

enableRefreshToken?: boolean

If enable the refresh token feature

Optional oauthCallbackTokenBehavior

oauthCallbackTokenBehavior?: OauthCallbackTokenBehavior

OAuth callback token behavior

Optional setTwoFactorAuth

setTwoFactorAuth?: false | {
    codeConfig?: {
        expireTime?: string | number;
        length?: number;
    };
    emailConfig: {
        bodyTemplate: string;
        sender: string;
        subject: string;
    };
}

The configuration for two factor auth

Type declaration

  • Optional codeConfig?: {
        expireTime?: string | number;
        length?: number;
    }

    The configuration for the code of 2FA

    • Optional expireTime?: string | number

      (Optional) the expire time of the validation

    • Optional length?: number

      Length of code

  • emailConfig: {
        bodyTemplate: string;
        sender: string;
        subject: string;
    }

    The configuration for the email of 2FA

    • bodyTemplate: string

      The Email body template

    • sender: string

      The Email sender template

    • subject: string

      The Email subject template

Optional tokenExpireTime

tokenExpireTime?: TokenExpireTime

(Optional) The expiration time of the JWT Token

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc