• management
• SDK
• SettingsClient

Class SettingsClient

Index

Constructors

constructor

Methods

getsetupdate

Properties

_options

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()Copy

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()Copy

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()Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods getsetupdate Properties _options