Class PushNotification

Index

Constructors

Methods

getApnsProvider setApnsProvider setFcmProvider setFcmv1Provider getSnsProvider setSnsProvider updateSnsProvider getSelectedProvider setProvider _getAuthorizationHeader

Properties

_options

Constructors

constructor

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

Methods

getApnsProvider

getApnsProvider(
requestOptions?: PushNotification.RequestOptions,
): HttpResponsePromise<GetGuardianFactorsProviderApnsResponseContent>
Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant.
Parameters
- OptionalrequestOptions: PushNotification.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorsProviderApnsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.pushNotification.getApnsProvider()
```

getSnsProvider

getSnsProvider(
requestOptions?: PushNotification.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: PushNotification.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorsProviderSnsResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.pushNotification.getSnsProvider()
```

setSnsProvider

setSnsProvider(
    request?: Management.SetGuardianFactorsProviderPushNotificationSnsRequestContent,
    requestOptions?: PushNotification.RequestOptions,
): HttpResponsePromise<
    SetGuardianFactorsProviderPushNotificationSnsResponseContent,
>
Configure the AWS SNS push notification provider configuration (subscription required).
Parameters
- request: Management.SetGuardianFactorsProviderPushNotificationSnsRequestContent = {}
- OptionalrequestOptions: PushNotification.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<
SetGuardianFactorsProviderPushNotificationSnsResponseContent,
>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.pushNotification.setSnsProvider()
```

updateSnsProvider

updateSnsProvider(
    request?: Management.UpdateGuardianFactorsProviderPushNotificationSnsRequestContent,
    requestOptions?: PushNotification.RequestOptions,
): HttpResponsePromise<
    UpdateGuardianFactorsProviderPushNotificationSnsResponseContent,
>
Configure the AWS SNS push notification provider configuration (subscription required).
Parameters
- request: Management.UpdateGuardianFactorsProviderPushNotificationSnsRequestContent = {}
- OptionalrequestOptions: PushNotification.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<
UpdateGuardianFactorsProviderPushNotificationSnsResponseContent,
>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.pushNotification.updateSnsProvider()
```

getSelectedProvider

getSelectedProvider(
requestOptions?: PushNotification.RequestOptions,
): HttpResponsePromise<
GetGuardianFactorsProviderPushNotificationResponseContent,
>
Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA.
Parameters
- OptionalrequestOptions: PushNotification.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetGuardianFactorsProviderPushNotificationResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError
Example
```
await client.guardian.factors.pushNotification.getSelectedProvider()
```

setProvider

setProvider(
    request: Management.SetGuardianFactorsProviderPushNotificationRequestContent,
    requestOptions?: PushNotification.RequestOptions,
): HttpResponsePromise<
    SetGuardianFactorsProviderPushNotificationResponseContent,
>
Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA.
Parameters
- request: Management.SetGuardianFactorsProviderPushNotificationRequestContent
- OptionalrequestOptions: PushNotification.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"
    })
```

`Protected`_getAuthorizationHeader

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

Properties

`Protected` `Readonly`_options

_options: PushNotification.Options

Class PushNotification

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns PushNotification

Methods

getApnsProvider

Parameters

Returns HttpResponsePromise<GetGuardianFactorsProviderApnsResponseContent>

Throws

Throws

Throws

Example

setApnsProvider

Parameters

Returns HttpResponsePromise< SetGuardianFactorsProviderPushNotificationApnsResponseContent,>

Throws

Throws

Throws

Example

setFcmProvider

Parameters

Returns HttpResponsePromise< SetGuardianFactorsProviderPushNotificationFcmResponseContent,>

Throws

Throws

Throws

Example

setFcmv1Provider

Parameters

Returns HttpResponsePromise< SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent,>

Throws

Throws

Throws

Example

getSnsProvider

Parameters

Returns HttpResponsePromise<GetGuardianFactorsProviderSnsResponseContent>

Throws

Throws

Throws

Example

setSnsProvider

Parameters

Returns HttpResponsePromise< SetGuardianFactorsProviderPushNotificationSnsResponseContent,>

Throws

Throws

Throws

Example

updateSnsProvider

Parameters

Returns HttpResponsePromise< UpdateGuardianFactorsProviderPushNotificationSnsResponseContent,>

Throws

Throws

Throws

Example

getSelectedProvider

Parameters

Returns HttpResponsePromise<GetGuardianFactorsProviderPushNotificationResponseContent>

Throws

Throws

Throws

Example

setProvider

Parameters

Returns HttpResponsePromise<SetGuardianFactorsProviderPushNotificationResponseContent>

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

Returns HttpResponsePromise<
SetGuardianFactorsProviderPushNotificationApnsResponseContent,
>

Returns HttpResponsePromise<
SetGuardianFactorsProviderPushNotificationFcmResponseContent,
>

Returns HttpResponsePromise<
SetGuardianFactorsProviderPushNotificationFcmv1ResponseContent,
>

Returns HttpResponsePromise<
SetGuardianFactorsProviderPushNotificationSnsResponseContent,
>

Returns HttpResponsePromise<
UpdateGuardianFactorsProviderPushNotificationSnsResponseContent,
>

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options