Back to Node Auth0

Class MultifactorClient

docs/classes/management.SDK.MultifactorClient.html

5.9.14.1 KB
Original Source

Class MultifactorClient

Index

Constructors

constructor

Methods

invalidateRememberBrowserdeleteProvider

Properties

_options

Constructors

constructor

new MultifactorClient(options: BaseClientOptions): MultifactorClient

Parameters

Returns MultifactorClient

Methods

invalidateRememberBrowser

invalidateRememberBrowser(
id: string,
requestOptions?: MultifactorClient.RequestOptions,
): HttpResponsePromise<void>

Invalidate all remembered browsers across all authentication factors for a user.

Parameters

  • id: string

ID of the user to invalidate all remembered browsers and authentication factors for.

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.users.multifactor.invalidateRememberBrowser("id")Copy

deleteProvider

deleteProvider(
id: string,
provider: Management.UserMultifactorProviderEnum,
requestOptions?: MultifactorClient.RequestOptions,
): HttpResponsePromise<void>

Remove a multifactor authentication configuration from a user's account. This forces the user to manually reconfigure the multi-factor provider.

Parameters

  • id: string

ID of the user to remove a multifactor configuration from.

The multi-factor provider. Supported values 'duo' or 'google-authenticator'

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.users.multifactor.deleteProvider("id", "duo")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods invalidateRememberBrowserdeleteProvider Properties _options