Class StytchAuthFactorOtpProvider<T>

Type Parameters

T extends FactorParser

Hierarchy

BaseProvider
- StytchAuthFactorOtpProvider

Index

Constructors

constructor

new StytchAuthFactorOtpProvider<T>(params: BaseProviderOptions, config: StytchOtpProviderOptions, factor: T): StytchAuthFactorOtpProvider<T>
Type Parameters
- T extends FactorParser
Parameters
- params: BaseProviderOptions
- config: StytchOtpProviderOptions
- factor: T
Returns StytchAuthFactorOtpProvider<T>
Overrides BaseProvider.constructor
- Defined in packages/lit-auth-client/src/lib/providers/StytchAuthFactorOtp.ts:27

Properties

`Private` _factor

_factor: T

`Private` _params

_params: StytchOtpProviderOptions

`Static` `Private` _provider

_provider: string = 'https://stytch.com/session'

Methods

authenticate

authenticate<T>(options?: T): Promise<AuthMethod>
Validates claims within a stytch authenticated JSON Web Token Will parse out the given authentication factor and use the transport for the otp code as the user identifier for the given auth method.

Returns
Authentication Method for auth method type OTP
Type Parameters
- T extends BaseAuthenticateOptions
Parameters
- Optional options: T
  
  authentication option containing the authenticated token
Returns Promise<AuthMethod>
Inherited from BaseProvider.authenticate
- Defined in packages/lit-auth-client/src/lib/providers/StytchAuthFactorOtp.ts:45

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/StytchAuthFactorOtp.ts:93

`Static` `Private` _parseJWT

_parseJWT(jwt: string): StytchToken
Returns
- userId contained within the token message
Parameters
- jwt: string
  
  token to parse
Returns StytchToken
- Defined in packages/lit-auth-client/src/lib/providers/StytchAuthFactorOtp.ts:170

`Static` `Private` _resolveAuthFactor

_resolveAuthFactor(factor: FactorParser): {
authMethodType: AuthMethodType;
parser: Function;
}
Parameters
- factor: FactorParser
Returns {
authMethodType: AuthMethodType;
parser: Function;
}
- authMethodType: AuthMethodType
- parser: Function
- Defined in packages/lit-auth-client/src/lib/providers/StytchAuthFactorOtp.ts:137

`Static` authMethodId

authMethodId(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. Will parse out the given authentication factor and use the transport for the otp code as the user identifier for the given auth method.

Returns
- Auth method id
Parameters
- authMethod: AuthMethod
  
  Auth method object
Returns Promise<string>
- Defined in packages/lit-auth-client/src/lib/providers/StytchAuthFactorOtp.ts:106

Class StytchAuthFactorOtpProvider<T>

Type Parameters

T extends FactorParser

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends FactorParser

Parameters

params: BaseProviderOptions

config: StytchOtpProviderOptions

factor: T

Returns StytchAuthFactorOtpProvider<T>

Properties

Private _factor

Private _params

Static Private _provider

Methods

authenticate

Returns

Type Parameters

T extends BaseAuthenticateOptions

Parameters

Optional options: T

Returns Promise<AuthMethod>

getAuthMethodId

Returns

Parameters

authMethod: AuthMethod

Returns Promise<string>

Static Private _parseJWT

Returns

Parameters

jwt: string

Returns StytchToken

Static Private _resolveAuthFactor

Parameters

factor: FactorParser

Returns { authMethodType: AuthMethodType; parser: Function; }

authMethodType: AuthMethodType

parser: Function

Static authMethodId

Returns

Parameters

authMethod: AuthMethod

Returns Promise<string>

Settings

Member Visibility

Theme

`Private` _factor

`Private` _params

`Static` `Private` _provider

`Optional` options: T

`Static` `Private` _parseJWT

`Static` `Private` _resolveAuthFactor

Returns {
authMethodType: AuthMethodType;
parser: Function;
}

`Static` authMethodId