Class SettingsClient

Index

Constructors

Methods

Properties

Constructors

constructor

new SettingsClient(options: BaseClientOptions): SettingsClient
Parameters
- options: BaseClientOptions
Returns SettingsClient

Methods

get

get(
requestOptions?: SettingsClient.RequestOptions,
): HttpResponsePromise<GetGuardianFactorDuoSettingsResponseContent>
Retrieves the DUO account and factor configuration.
Parameters
- OptionalrequestOptions: SettingsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorDuoSettingsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.duo.settings.get()
```

set

set(
request?: SetGuardianFactorDuoSettingsRequestContent,
requestOptions?: SettingsClient.RequestOptions,
): HttpResponsePromise<SetGuardianFactorDuoSettingsResponseContent>
Set the DUO account configuration and other properties specific to this factor.
Parameters
- request: SetGuardianFactorDuoSettingsRequestContent = {}
- OptionalrequestOptions: SettingsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetGuardianFactorDuoSettingsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.duo.settings.set()
```

update

update(
request?: UpdateGuardianFactorDuoSettingsRequestContent,
requestOptions?: SettingsClient.RequestOptions,
): HttpResponsePromise<UpdateGuardianFactorDuoSettingsResponseContent>
Parameters
- request: UpdateGuardianFactorDuoSettingsRequestContent = {}
- OptionalrequestOptions: SettingsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateGuardianFactorDuoSettingsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.duo.settings.update()
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>