• management
• SDK
• PushNotificationClient

Class PushNotificationClient

Index

Constructors

constructor

Methods

getApnsProvidersetApnsProviderupdateApnsProvidersetFcmProviderupdateFcmProvidersetFcmv1ProviderupdateFcmv1ProvidergetSnsProvidersetSnsProviderupdateSnsProvidergetSelectedProvidersetProvider

Properties

_options

Constructors

constructor

new PushNotificationClient(options: BaseClientOptions): PushNotificationClient

Parameters

• options: BaseClientOptions

Returns PushNotificationClient

Methods

getApnsProvider

getApnsProvider(
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<GetGuardianFactorsProviderApnsResponseContent>

Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant.

Parameters

• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetGuardianFactorsProviderApnsResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.getApnsProvider()Copy

setApnsProvider

setApnsProvider(
request?: SetGuardianFactorsProviderPushNotificationApnsRequestContent,
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<
SetGuardianFactorsProviderPushNotificationApnsResponseContent,
>

Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant.

Parameters

• request: SetGuardianFactorsProviderPushNotificationApnsRequestContent = {}
• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise< SetGuardianFactorsProviderPushNotificationApnsResponseContent, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.setApnsProvider()Copy

updateApnsProvider

updateApnsProvider(
request?: UpdateGuardianFactorsProviderPushNotificationApnsRequestContent,
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<
UpdateGuardianFactorsProviderPushNotificationApnsResponseContent,
>

Modify configuration details of the multi-factor authentication APNS provider associated with your tenant.

Parameters

• request: UpdateGuardianFactorsProviderPushNotificationApnsRequestContent = {}
• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise< UpdateGuardianFactorsProviderPushNotificationApnsResponseContent, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.updateApnsProvider()Copy

setFcmProvider

setFcmProvider(
request?: SetGuardianFactorsProviderPushNotificationFcmRequestContent,
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<
SetGuardianFactorsProviderPushNotificationFcmResponseContent,
>

Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant.

Parameters

• request: SetGuardianFactorsProviderPushNotificationFcmRequestContent = {}
• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise< SetGuardianFactorsProviderPushNotificationFcmResponseContent, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.setFcmProvider()Copy

updateFcmProvider

updateFcmProvider(
request?: UpdateGuardianFactorsProviderPushNotificationFcmRequestContent,
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<
UpdateGuardianFactorsProviderPushNotificationFcmResponseContent,
>

Modify configuration details of the multi-factor authentication FCM provider associated with your tenant.

Parameters

• request: UpdateGuardianFactorsProviderPushNotificationFcmRequestContent = {}
• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise< UpdateGuardianFactorsProviderPushNotificationFcmResponseContent, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.updateFcmProvider()Copy

setFcmv1Provider

setFcmv1Provider(
request?: SetGuardianFactorsProviderPushNotificationFcmv1RequestContent,
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<
SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent,
>

Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.

Parameters

• request: SetGuardianFactorsProviderPushNotificationFcmv1RequestContent = {}
• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise< SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.setFcmv1Provider()Copy

updateFcmv1Provider

updateFcmv1Provider(
request?: UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent,
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<
UpdateGuardianFactorsProviderPushNotificationFcmv1ResponseContent,
>

Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant.

Parameters

• request: UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent = {}
• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise< UpdateGuardianFactorsProviderPushNotificationFcmv1ResponseContent, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.updateFcmv1Provider()Copy

getSnsProvider

getSnsProvider(
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<GetGuardianFactorsProviderSnsResponseContent>

Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA. To learn more, review Configure Push Notifications for MFA.

Parameters

• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetGuardianFactorsProviderSnsResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.getSnsProvider()Copy

setSnsProvider

setSnsProvider(
request?: SetGuardianFactorsProviderPushNotificationSnsRequestContent,
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<
SetGuardianFactorsProviderPushNotificationSnsResponseContent,
>

Configure the AWS SNS push notification provider configuration (subscription required).

Parameters

• request: SetGuardianFactorsProviderPushNotificationSnsRequestContent = {}
• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise< SetGuardianFactorsProviderPushNotificationSnsResponseContent, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.setSnsProvider()Copy

updateSnsProvider

updateSnsProvider(
request?: UpdateGuardianFactorsProviderPushNotificationSnsRequestContent,
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<
UpdateGuardianFactorsProviderPushNotificationSnsResponseContent,
>

Configure the AWS SNS push notification provider configuration (subscription required).

Parameters

• request: UpdateGuardianFactorsProviderPushNotificationSnsRequestContent = {}
• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise< UpdateGuardianFactorsProviderPushNotificationSnsResponseContent, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.updateSnsProvider()Copy

getSelectedProvider

getSelectedProvider(
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<
GetGuardianFactorsProviderPushNotificationResponseContent,
>

Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA.

Parameters

• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetGuardianFactorsProviderPushNotificationResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.getSelectedProvider()Copy

setProvider

setProvider(
request: SetGuardianFactorsProviderPushNotificationRequestContent,
requestOptions?: PushNotificationClient.RequestOptions,
): HttpResponsePromise<
SetGuardianFactorsProviderPushNotificationResponseContent,
>

Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA.

Parameters

• request: SetGuardianFactorsProviderPushNotificationRequestContent
• OptionalrequestOptions: PushNotificationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<SetGuardianFactorsProviderPushNotificationResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Example

await client.guardian.factors.pushNotification.setProvider({ provider: "guardian" })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods getApnsProvidersetApnsProviderupdateApnsProvidersetFcmProviderupdateFcmProvidersetFcmv1ProviderupdateFcmv1ProvidergetSnsProvidersetSnsProviderupdateSnsProvidergetSelectedProvidersetProvider Properties _options