AccountsBoostOptions

@accounts/boostGlobalsAccountsBoostOptions

Type parameters

CustomUser: User

Hierarchy

  • AccountsServerOptions

    AccountsBoostOptions

Index

Properties

Properties

Optional ambiguousErrorMessages

ambiguousErrorMessages? : boolean

Inherited from AccountsBoostOptions.ambiguousErrorMessages

Defined in server/lib/types/accounts-server-options.d.ts:13

Return ambiguous error messages from login failures to prevent user enumeration. Defaults to true.


Optional createJwtPayload

createJwtPayload? : function

Inherited from AccountsBoostOptions.createJwtPayload

Defined in server/lib/types/accounts-server-options.d.ts:42

Function to add addition information in jwt payload of accessToken

Type declaration:

▸ (data: JwtData, user: CustomUser): Promise‹Record‹string, any››

Parameters:

NameType
dataJwtData
userCustomUser

Optional createNewSessionTokenOnRefresh

createNewSessionTokenOnRefresh? : boolean

Inherited from AccountsBoostOptions.createNewSessionTokenOnRefresh

Defined in server/lib/types/accounts-server-options.d.ts:38

Creates a new session token each time a user refreshes his access token


Optional db

db? : DatabaseInterface‹CustomUser›

Inherited from AccountsBoostOptions.db

Defined in server/lib/types/accounts-server-options.d.ts:14


Optional emailTemplates

emailTemplates? : EmailTemplatesType

Inherited from AccountsBoostOptions.emailTemplates

Defined in server/lib/types/accounts-server-options.d.ts:23


Optional enableAutologin

enableAutologin? : boolean

Inherited from AccountsBoostOptions.enableAutologin

Defined in server/lib/types/accounts-server-options.d.ts:47

If this flag is set to true - user will be automatically logged in after registration. LoginResult data will be included into registration response.


Optional impersonationAuthorize

impersonationAuthorize? : function

Inherited from AccountsBoostOptions.impersonationAuthorize

Defined in server/lib/types/accounts-server-options.d.ts:25

Type declaration:

▸ (user: User, impersonateToUser: User): Promise‹any›

Parameters:

NameType
userUser
impersonateToUserUser

Optional micro

micro? : boolean

Defined in boost/src/index.ts:20


Optional prepareMail

prepareMail? : PrepareMailFunction

Inherited from AccountsBoostOptions.prepareMail

Defined in server/lib/types/accounts-server-options.d.ts:32


Optional resumeSessionValidator

resumeSessionValidator? : function

Inherited from AccountsBoostOptions.resumeSessionValidator

Defined in server/lib/types/accounts-server-options.d.ts:30

Use this function if you want to cancel the current session to be resumed. The session parameter will be null if the useStatelessSession option is set to true.

Type declaration:

▸ (user: User, session: Session): Promise‹void›

Parameters:

NameType
userUser
sessionSession

Optional sendMail

sendMail? : SendMailType

Inherited from AccountsBoostOptions.sendMail

Defined in server/lib/types/accounts-server-options.d.ts:33


Optional siteUrl

siteUrl? : string

Inherited from AccountsBoostOptions.siteUrl

Defined in server/lib/types/accounts-server-options.d.ts:31


Optional storage

storage? : object

Defined in boost/src/index.ts:16

Type declaration:

  • name? : string

  • uri? : string


Optional tokenConfigs

tokenConfigs? : object

Inherited from AccountsBoostOptions.tokenConfigs

Defined in server/lib/types/accounts-server-options.d.ts:19

Type declaration:

  • accessToken? : SignOptions

  • refreshToken? : SignOptions


Optional tokenCreator

tokenCreator? : TokenCreator

Inherited from AccountsBoostOptions.tokenCreator

Defined in server/lib/types/accounts-server-options.d.ts:34


tokenSecret

tokenSecret: string | object

Inherited from AccountsBoostOptions.tokenSecret

Defined in server/lib/types/accounts-server-options.d.ts:15


Optional useInternalUserObjectSanitizer

useInternalUserObjectSanitizer? : boolean

Inherited from AccountsBoostOptions.useInternalUserObjectSanitizer

Defined in server/lib/types/accounts-server-options.d.ts:52

Set this false to false if you wish to skip internal user sanitazing method, and expose the original User object as-is.


Optional useStatelessSession

useStatelessSession? : boolean

Inherited from AccountsBoostOptions.useStatelessSession

Defined in server/lib/types/accounts-server-options.d.ts:62

Should the session mechanism be stateless. By default the token is checked against the database in every request. This allow you to revoke a session at any time. Since we are using JWT you can decide to have a stateless session. This means that the token won't be checked against the database on every request. Using the stateless approach will make the server authorisation check faster but this means that you won't be able to able to invalidate the access token until it's expired. Only use this option if you understand the downsides of this approach. Default 'false'.


Optional userObjectSanitizer

userObjectSanitizer? : UserObjectSanitizerFunction

Inherited from AccountsBoostOptions.userObjectSanitizer

Defined in server/lib/types/accounts-server-options.d.ts:24