Interface GoTrueAdminMFAApi

Contains the full multi-factor authentication administration API.

expermental

Hierarchy

GoTrueAdminMFAApi

Index

Methods

Methods

deleteFactor

deleteFactor(params: AuthMFAAdminDeleteFactorParams): Promise<AuthMFAAdminDeleteFactorResponse>

- Defined in src/lib/types.ts:1070
Deletes a factor on a user. This will log the user out of all active sessions if the deleted factor was verified.

see
{@link GoTrueMFAApi#unenroll}

expermental
Parameters
- params: AuthMFAAdminDeleteFactorParams
Returns Promise<AuthMFAAdminDeleteFactorResponse>

listFactors

listFactors(params: AuthMFAAdminListFactorsParams): Promise<AuthMFAAdminListFactorsResponse>

- Defined in src/lib/types.ts:1060
Lists all factors associated to a user.

Parameters
- params: AuthMFAAdminListFactorsParams
Returns Promise<AuthMFAAdminListFactorsResponse>

Generated using TypeDoc