Class Multifactor

Index

Constructors

Methods

invalidateRememberBrowser deleteProvider _getAuthorizationHeader

Properties

Constructors

constructor

new Multifactor(_options: Multifactor.Options): Multifactor
Parameters
- _options: Multifactor.Options
Returns Multifactor

Methods

invalidateRememberBrowser

invalidateRememberBrowser(
id: string,
requestOptions?: Multifactor.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: Multifactor.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?: Multifactor.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: Multifactor.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")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Multifactor.Options