Class OtpProvider

Hierarchy

BaseProvider
- OtpProvider

Index

Constructors

Properties

_baseUrl _checkRoute _params _port _requestId _startRoute

Methods

#parseJWT _buildUrl authenticate checkOtpCode getAuthMethodId sendOtpCode

Constructors

constructor

new OtpProvider(params: BaseProviderOptions & SignInWithOTPParams, config?: OtpProviderOptions): OtpProvider
Parameters
- params: BaseProviderOptions & SignInWithOTPParams
- Optional config: OtpProviderOptions
Returns OtpProvider
Overrides BaseProvider.constructor
- Defined in packages/lit-auth-client/src/lib/providers/OtpProvider.ts:21

Properties

`Private` _baseUrl

_baseUrl: string

`Private` _checkRoute

_checkRoute: string

`Private` _params

_params: SignInWithOTPParams

`Private` _port

_port: string

`Private` _requestId

_requestId: string = ''

`Private` _startRoute

_startRoute: string

Methods

`Private` #parseJWT

#parseJWT(jwt: string): Record<string, unknown>
Parse OTP token

Returns
- Parsed body
Parameters
- jwt: string
  
  Token to parse
Returns Record<string, unknown>
- Defined in packages/lit-auth-client/src/lib/providers/OtpProvider.ts:185

`Private` _buildUrl

_buildUrl(route: string): string
Parameters
- route: string
Returns string
- Defined in packages/lit-auth-client/src/lib/providers/OtpProvider.ts:148

authenticate

authenticate<T>(options?: T): Promise<AuthMethod>
Validates OTP code from sendOtpCode

Returns
Auth Method object containing Json Web Token
Type Parameters
- T extends BaseAuthenticateOptions
Parameters
- Optional options: T
  
  {T extends AuthenticateOptions} options used in authentication
Returns Promise<AuthMethod>
Inherited from BaseProvider.authenticate
- Defined in packages/lit-auth-client/src/lib/providers/OtpProvider.ts:38

`Private` checkOtpCode

checkOtpCode(code: string): Promise<AuthMethod>
Validates otp code from sendOtpCode

Returns
- Auth method that contains Json Web Token
Parameters
- code: string
  
  {string} - OTP code sent to the user, should be retrieved from user input.
Returns Promise<AuthMethod>
- Defined in packages/lit-auth-client/src/lib/providers/OtpProvider.ts:105

getAuthMethodId

getAuthMethodId(authMethod: AuthMethod): Promise<string>
Get auth method id that can be used to look up and interact with PKPs associated with the given auth method

Returns
- Auth method id
Parameters
- authMethod: AuthMethod
  
  Auth method object
Returns Promise<string>
Inherited from BaseProvider.getAuthMethodId
- Defined in packages/lit-auth-client/src/lib/providers/OtpProvider.ts:167

sendOtpCode

sendOtpCode(): Promise<string>
Starts an otp session for a given email or phone number from the SignInWithOTPParams

Returns
returns a callback to check status of the verification session if successful

Returns Promise<string>
- Defined in packages/lit-auth-client/src/lib/providers/OtpProvider.ts:56

Generated using TypeDoc