Class MultifactorClient

Index

Constructors

Methods

invalidateRememberBrowser deleteProvider

Properties

Constructors

constructor

new MultifactorClient(options: BaseClientOptions): MultifactorClient
Parameters
- options: BaseClientOptions
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.
- OptionalrequestOptions: MultifactorClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.users.multifactor.invalidateRememberBrowser("id")
```

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.
- provider: Management.UserMultifactorProviderEnum
  The multi-factor provider. Supported values 'duo' or 'google-authenticator'
- OptionalrequestOptions: MultifactorClient.RequestOptions
  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")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>