Skip to main content

@accounts/rest-express

@accounts/rest-express โ€บ Globals

Index

Interfaces

Type aliases

Functions

Object literals

Type aliases

OAuthErrorCallback

ฦฌ OAuthErrorCallback: function

Defined in packages/rest-express/src/types.ts:9

Type declaration:

โ–ธ (req: express.Request, res: express.Response, error: any): void

Parameters:

NameType
reqexpress.Request
resexpress.Response
errorany

OAuthSuccessCallback

ฦฌ OAuthSuccessCallback: function

Defined in packages/rest-express/src/types.ts:4

Type declaration:

โ–ธ (req: express.Request, res: express.Response, login: LoginResult): void

Parameters:

NameType
reqexpress.Request
resexpress.Response
loginLoginResult

TransformOAuthResponse

ฦฌ TransformOAuthResponse: function

Defined in packages/rest-express/src/types.ts:10

Type declaration:

โ–ธ (login: LoginResult): T

Parameters:

NameType
loginLoginResult

Functions

Const accountsExpress

โ–ธ accountsExpress(accountsServer: AccountsServer, options: AccountsExpressOptions): express.Router

Defined in packages/rest-express/src/express-middleware.ts:26

Parameters:

NameTypeDefault
accountsServerAccountsServer-
optionsAccountsExpressOptions{}

Returns: express.Router


Const addEmail

โ–ธ addEmail(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/password/add-email.ts:6

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const changePassword

โ–ธ changePassword(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/password/change-password.ts:6

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const getUser

โ–ธ getUser(): (Anonymous function)

Defined in packages/rest-express/src/endpoints/get-user.ts:3

Returns: (Anonymous function)


Const getUserAgent

โ–ธ getUserAgent(req: express.Request): string

Defined in packages/rest-express/src/utils/get-user-agent.ts:3

Parameters:

NameType
reqexpress.Request

Returns: string


Const impersonate

โ–ธ impersonate(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/impersonate.ts:6

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const logout

โ–ธ logout(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/logout.ts:5

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const providerCallback

โ–ธ providerCallback(accountsServer: AccountsServer, options?: AccountsExpressOptions): (Anonymous function)

Defined in packages/rest-express/src/endpoints/oauth/provider-callback.ts:10

Parameters:

NameType
accountsServerAccountsServer
options?AccountsExpressOptions

Returns: (Anonymous function)


Const refreshAccessToken

โ–ธ refreshAccessToken(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/refresh-access-token.ts:5

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const registerPassword

โ–ธ registerPassword(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/password/register.ts:7

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const requestMagicLinkEmail

โ–ธ requestMagicLinkEmail(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/magic-link/request-magic-link-email.ts:6

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const resetPassword

โ–ธ resetPassword(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/password/reset.ts:6

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const sendError

โ–ธ sendError(res: any, err: any): any

Defined in packages/rest-express/src/utils/send-error.ts:1

Parameters:

NameType
resany
errany

Returns: any


Const sendResetPasswordEmail

โ–ธ sendResetPasswordEmail(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/password/reset.ts:18

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const sendVerificationEmail

โ–ธ sendVerificationEmail(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/password/verify-email.ts:18

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const serviceAuthenticate

โ–ธ serviceAuthenticate(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/service-authenticate.ts:5

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const serviceVerifyAuthentication

โ–ธ serviceVerifyAuthentication(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/verify-authentication.ts:5

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const twoFactorSecret

โ–ธ twoFactorSecret(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/password/two-factor.ts:6

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const twoFactorSet

โ–ธ twoFactorSet(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/password/two-factor.ts:17

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const twoFactorUnset

โ–ธ twoFactorUnset(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/password/two-factor.ts:34

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const userLoader

โ–ธ userLoader(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/user-loader.ts:4

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const verifyEmail

โ–ธ verifyEmail(accountsServer: AccountsServer): (Anonymous function)

Defined in packages/rest-express/src/endpoints/password/verify-email.ts:6

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)

Object literals

Const defaultOptions

โ–ช defaultOptions: object

Defined in packages/rest-express/src/express-middleware.ts:22

path

โ€ข path: string = "/accounts"

Defined in packages/rest-express/src/express-middleware.ts:23