@accounts/rest-express

@accounts/rest-expressGlobals

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:23

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:8

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:12

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:7

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const registerPassword

registerPassword(accountsServer: AccountsServer): (Anonymous function)

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

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const resetPassword

resetPassword(accountsServer: AccountsServer): (Anonymous function)

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

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:24

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const sendVerificationEmail

sendVerificationEmail(accountsServer: AccountsServer): (Anonymous function)

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

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const serviceAuthenticate

serviceAuthenticate(accountsServer: AccountsServer): (Anonymous function)

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

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const serviceVerifyAuthentication

serviceVerifyAuthentication(accountsServer: AccountsServer): (Anonymous function)

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

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:19

Parameters:

NameType
accountsServerAccountsServer

Returns: (Anonymous function)


Const twoFactorUnset

twoFactorUnset(accountsServer: AccountsServer): (Anonymous function)

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

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:19

path

path: string = "/accounts"

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