@accounts/rest-express
@accounts/rest-express โบ Globals
Index
Interfaces
Type aliases
Functions
- accountsExpress
- addEmail
- changePassword
- getUser
- getUserAgent
- impersonate
- logout
- providerCallback
- refreshAccessToken
- registerPassword
- requestMagicLinkEmail
- resetPassword
- sendError
- sendResetPasswordEmail
- sendVerificationEmail
- serviceAuthenticate
- serviceVerifyAuthentication
- twoFactorSecret
- twoFactorSet
- twoFactorUnset
- userLoader
- verifyEmail
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:
Name | Type |
---|---|
req | express.Request |
res | express.Response |
error | any |
OAuthSuccessCallback
ฦฌ OAuthSuccessCallback: function
Defined in packages/rest-express/src/types.ts:4
Type declaration:
โธ (req
: express.Request, res
: express.Response, login
: LoginResult): void
Parameters:
Name | Type |
---|---|
req | express.Request |
res | express.Response |
login | LoginResult |
TransformOAuthResponse
ฦฌ TransformOAuthResponse: function
Defined in packages/rest-express/src/types.ts:10
Type declaration:
โธ (login
: LoginResult): T
Parameters:
Name | Type |
---|---|
login | LoginResult |
Functions
Const
accountsExpress
โธ accountsExpress(accountsServer
: AccountsServer, options
: AccountsExpressOptions): express.Router
Defined in packages/rest-express/src/express-middleware.ts:26
Parameters:
Name | Type | Default |
---|---|---|
accountsServer | AccountsServer | - |
options | AccountsExpressOptions | {} |
Returns: express.Router
Const
addEmail
โธ addEmail(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/password/add-email.ts:6
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
changePassword
โธ changePassword(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/password/change-password.ts:6
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
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:
Name | Type |
---|---|
req | express.Request |
Returns: string
Const
impersonate
โธ impersonate(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/impersonate.ts:6
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
logout
โธ logout(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/logout.ts:5
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
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:
Name | Type |
---|---|
accountsServer | AccountsServer |
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:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
registerPassword
โธ registerPassword(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/password/register.ts:7
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
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:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
resetPassword
โธ resetPassword(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/password/reset.ts:6
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
sendError
โธ sendError(res
: any, err
: any): any
Defined in packages/rest-express/src/utils/send-error.ts:1
Parameters:
Name | Type |
---|---|
res | any |
err | any |
Returns: any
Const
sendResetPasswordEmail
โธ sendResetPasswordEmail(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/password/reset.ts:18
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
sendVerificationEmail
โธ sendVerificationEmail(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/password/verify-email.ts:18
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
serviceAuthenticate
โธ serviceAuthenticate(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/service-authenticate.ts:5
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
serviceVerifyAuthentication
โธ serviceVerifyAuthentication(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/verify-authentication.ts:5
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
twoFactorSecret
โธ twoFactorSecret(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/password/two-factor.ts:6
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
twoFactorSet
โธ twoFactorSet(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/password/two-factor.ts:17
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
twoFactorUnset
โธ twoFactorUnset(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/password/two-factor.ts:34
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
userLoader
โธ userLoader(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/user-loader.ts:4
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
Returns: (Anonymous function)
Const
verifyEmail
โธ verifyEmail(accountsServer
: AccountsServer): (Anonymous function)
Defined in packages/rest-express/src/endpoints/password/verify-email.ts:6
Parameters:
Name | Type |
---|---|
accountsServer | AccountsServer |
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