class.TFAService.md

directus-monorepo ( Readme | API )

---

directus-monorepo > TFAService

Class: TFAService

Constructors

constructor()

new TFAService(options): TFAService

Parameters

Parameter	Type
options	AbstractServiceOptions

Returns

TFAService

Source

api/src/services/tfa.ts:12

Properties

itemsService

itemsService: ItemsService< Item >

Source

api/src/services/tfa.ts:10

---

knex

knex: Knex< any, any[] >

Source

api/src/services/tfa.ts:9

Methods

disableTFA()

disableTFA(key): Promise< void >

Parameters

Parameter	Type
key	PrimaryKey

Returns

Promise< void >

Source

api/src/services/tfa.ts:65

---

enableTFA()

enableTFA( key, otp, secret): Promise< void >

Parameters

Parameter	Type
key	PrimaryKey
otp	string
secret	string

Returns

Promise< void >

Source

api/src/services/tfa.ts:51

---

generateTFA()

generateTFA(key): Promise< Record< string, string > >

Parameters

Parameter	Type
key	PrimaryKey

Returns

Promise< Record< string, string > >

Source

api/src/services/tfa.ts:31

---

verifyOTP()

verifyOTP( key, otp, secret?): Promise< boolean >

Parameters

Parameter	Type
key	PrimaryKey
otp	string
secret?	string

Returns

Promise< boolean >

Source

api/src/services/tfa.ts:17

---

Generated using TypeDoc and typedoc-plugin-markdown