Skip to content

Module: client/apis/TwoStepVerificationAPI

Table of contents

Classes

Type aliases

Type aliases

AuthenticatorDisable

Ƭ AuthenticatorDisable: unknown

Defined in: client/apis/TwoStepVerificationAPI.ts:37

AuthenticatorDisableOptions

Ƭ AuthenticatorDisableOptions: object

Type declaration:

Name Type
password string

Defined in: client/apis/TwoStepVerificationAPI.ts:34

AuthenticatorEnable

Ƭ AuthenticatorEnable: object

Type declaration:

Name Type
manualEntryKey string
qrCodeImageUrl string
setupToken string

Defined in: client/apis/TwoStepVerificationAPI.ts:41

AuthenticatorEnableOptions

Ƭ AuthenticatorEnableOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/TwoStepVerificationAPI.ts:38

AuthenticatorVerify

Ƭ AuthenticatorVerify: object

Type declaration:

Name Type
verificationToken string

Defined in: client/apis/TwoStepVerificationAPI.ts:31

AuthenticatorVerifyOptions

Ƭ AuthenticatorVerifyOptions: object

Type declaration:

Name Type
actionType string
challengeId string
code string

Defined in: client/apis/TwoStepVerificationAPI.ts:26

AuthenticatorVerifySetup

Ƭ AuthenticatorVerifySetup: unknown

Defined in: client/apis/TwoStepVerificationAPI.ts:50

AuthenticatorVerifySetupOptions

Ƭ AuthenticatorVerifySetupOptions: object

Type declaration:

Name Type
code string
setupToken string

Defined in: client/apis/TwoStepVerificationAPI.ts:46

EmailDisable

Ƭ EmailDisable: unknown

Defined in: client/apis/TwoStepVerificationAPI.ts:70

EmailDisableOptions

Ƭ EmailDisableOptions: object

Type declaration:

Name Type
password string

Defined in: client/apis/TwoStepVerificationAPI.ts:67

EmailEnable

Ƭ EmailEnable: unknown

Defined in: client/apis/TwoStepVerificationAPI.ts:74

EmailEnableOptions

Ƭ EmailEnableOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/TwoStepVerificationAPI.ts:71

EmailSendCode

Ƭ EmailSendCode: object

Type declaration:

Name Type
actionType string
challengeId string

Defined in: client/apis/TwoStepVerificationAPI.ts:55

EmailSendCodeOptions

Ƭ EmailSendCodeOptions: object

Type declaration:

Name Type
actionType string
challengeId string

Defined in: client/apis/TwoStepVerificationAPI.ts:51

EmailVerify

Ƭ EmailVerify: object

Type declaration:

Name Type
verificationToken string

Defined in: client/apis/TwoStepVerificationAPI.ts:64

EmailVerifyOptions

Ƭ EmailVerifyOptions: object

Type declaration:

Name Type
actionType string
challengeId string
code string

Defined in: client/apis/TwoStepVerificationAPI.ts:59

GetTwoStepConfiguration

Ƭ GetTwoStepConfiguration: object

Type declaration:

Name Type
methods { enabled: boolean ; mediaType: Email | string ; updated: string }[]
primaryMediaType Email | string

Defined in: client/apis/TwoStepVerificationAPI.ts:18

GetTwoStepConfigurationOptions

Ƭ GetTwoStepConfigurationOptions: GetTwoStepVerificationMetaDataOptions

Defined in: client/apis/TwoStepVerificationAPI.ts:17

GetTwoStepVerificationMetaData

Ƭ GetTwoStepVerificationMetaData: object

Type declaration:

Name Type
authenticatorCodeLength number
authenticatorEnabled boolean
authenticatorQrCodeSize string
emailCodeLength number
twoStepVerificationEnabled boolean

Defined in: client/apis/TwoStepVerificationAPI.ts:10

GetTwoStepVerificationMetaDataOptions

Ƭ GetTwoStepVerificationMetaDataOptions: object

Type declaration:

Name Type
actionType string
challengeId string
userId number

Defined in: client/apis/TwoStepVerificationAPI.ts:5