UserPasswordAuthProviderClient

A client for interacting with username/password authentication provider in Stitch.

Index

Variables

factory

Methods

Variables

Const factory

factory: AuthProviderClientFactory<UserPasswordAuthProviderClient> = new classimplements AuthProviderClientFactory<UserPasswordAuthProviderClient> {public getClient(authRequestClient: StitchAuthRequestClient, // This arg is ignoredrequestClient: StitchRequestClient,routes: StitchAuthRoutes): UserPasswordAuthProviderClient {return new UserPasswordAuthProviderClientImpl(requestClient, routes);}}()

Methods

callResetPasswordFunction

callResetPasswordFunction(email: string, password: string, args: any[]): Promise<void>

- Defined in server/core/src/core/auth/providers/userpassword/UserPasswordAuthProviderClient.ts:67
Call a reset password function configured to the provider.

Parameters
- email: string
- password: string
- args: any[]
Returns Promise<void>

A {@link Task} that completes when the reqest request completes/fails.

confirmUser

confirmUser(token: string, tokenId: string): Promise<void>

- Defined in server/core/src/core/auth/providers/userpassword/UserPasswordAuthProviderClient.ts:42
Confirms a user with the given token and token id.

Parameters
- token: string
- tokenId: string
Returns Promise<void>

A Promise that completes when confirmation completes/fails.

registerWithEmail

registerWithEmail(email: string, password: string): Promise<void>

- Defined in server/core/src/core/auth/providers/userpassword/UserPasswordAuthProviderClient.ts:35
Registers a new user with the given email and password.

Parameters
- email: string
- password: string
Returns Promise<void>

A Promise that completes when registration completes/fails.

resendConfirmationEmail

resendConfirmationEmail(email: string): Promise<void>

- Defined in server/core/src/core/auth/providers/userpassword/UserPasswordAuthProviderClient.ts:49
Resend the confirmation for a user to the given email.

Parameters
- email: string
Returns Promise<void>

A Promise that completes when the resend request completes/fails.

resetPassword

resetPassword(token: string, tokenId: string, password: string): Promise<void>

- Defined in server/core/src/core/auth/providers/userpassword/UserPasswordAuthProviderClient.ts:56
Reset the password of a user with the given token, token id, and new password.

Parameters
- token: string
- tokenId: string
- password: string
Returns Promise<void>

A Promise that completes when the password reset completes/fails.

sendResetPasswordEmail

sendResetPasswordEmail(email: string): Promise<void>

- Defined in server/core/src/core/auth/providers/userpassword/UserPasswordAuthProviderClient.ts:73
Sends a user a password reset email for the given email.

Parameters
- email: string
Returns Promise<void>

A Promise that completes when the reqest request completes/fails.

Generated using TypeDoc

UserPasswordAuthProviderClient

Index

Variables

Methods

Variables

Const factory

Methods

callResetPasswordFunction

Parameters

email: string

password: string

args: any[]

Returns Promise<void>

confirmUser

Parameters

token: string

tokenId: string

Returns Promise<void>

registerWithEmail

Parameters

email: string

password: string

Returns Promise<void>

resendConfirmationEmail

Parameters

email: string

Returns Promise<void>

resetPassword

Parameters

token: string

tokenId: string

password: string

Returns Promise<void>

sendResetPasswordEmail

Parameters

email: string

Returns Promise<void>