Interface IPushNotificationClient

Namespace

Auth0.ManagementApi.Guardian.Factors

Assembly

Auth0.ManagementApi.dll

public interface IPushNotificationClient

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Methods

GetApnsProviderAsync(RequestOptions?, CancellationToken)

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

WithRawResponseTask<GetGuardianFactorsProviderApnsResponseContent> GetApnsProviderAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderApnsResponseContent>

GetSelectedProviderAsync(RequestOptions?, CancellationToken)

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

WithRawResponseTask<GetGuardianFactorsProviderPushNotificationResponseContent> GetSelectedProviderAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderPushNotificationResponseContent>

GetSnsProviderAsync(RequestOptions?, CancellationToken)

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.

WithRawResponseTask<GetGuardianFactorsProviderSnsResponseContent> GetSnsProviderAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderSnsResponseContent>

SetApnsProviderAsync(SetGuardianFactorsProviderPushNotificationApnsRequestContent, RequestOptions?, CancellationToken)

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

WithRawResponseTask<SetGuardianFactorsProviderPushNotificationApnsResponseContent> SetApnsProviderAsync(SetGuardianFactorsProviderPushNotificationApnsRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SetGuardianFactorsProviderPushNotificationApnsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderPushNotificationApnsResponseContent>

SetFcmProviderAsync(SetGuardianFactorsProviderPushNotificationFcmRequestContent, RequestOptions?, CancellationToken)

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

WithRawResponseTask<Dictionary<string, object?>> SetFcmProviderAsync(SetGuardianFactorsProviderPushNotificationFcmRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SetGuardianFactorsProviderPushNotificationFcmRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<Dictionary<string, object>>

SetFcmv1ProviderAsync(SetGuardianFactorsProviderPushNotificationFcmv1RequestContent, RequestOptions?, CancellationToken)

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

WithRawResponseTask<Dictionary<string, object?>> SetFcmv1ProviderAsync(SetGuardianFactorsProviderPushNotificationFcmv1RequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SetGuardianFactorsProviderPushNotificationFcmv1RequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<Dictionary<string, object>>

SetProviderAsync(SetGuardianFactorsProviderPushNotificationRequestContent, RequestOptions?, CancellationToken)

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

WithRawResponseTask<SetGuardianFactorsProviderPushNotificationResponseContent> SetProviderAsync(SetGuardianFactorsProviderPushNotificationRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SetGuardianFactorsProviderPushNotificationRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderPushNotificationResponseContent>

SetSnsProviderAsync(SetGuardianFactorsProviderPushNotificationSnsRequestContent, RequestOptions?, CancellationToken)

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

WithRawResponseTask<SetGuardianFactorsProviderPushNotificationSnsResponseContent> SetSnsProviderAsync(SetGuardianFactorsProviderPushNotificationSnsRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SetGuardianFactorsProviderPushNotificationSnsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderPushNotificationSnsResponseContent>

UpdateApnsProviderAsync(UpdateGuardianFactorsProviderPushNotificationApnsRequestContent, RequestOptions?, CancellationToken)

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

WithRawResponseTask<UpdateGuardianFactorsProviderPushNotificationApnsResponseContent> UpdateApnsProviderAsync(UpdateGuardianFactorsProviderPushNotificationApnsRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request UpdateGuardianFactorsProviderPushNotificationApnsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateGuardianFactorsProviderPushNotificationApnsResponseContent>

UpdateFcmProviderAsync(UpdateGuardianFactorsProviderPushNotificationFcmRequestContent, RequestOptions?, CancellationToken)

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

WithRawResponseTask<Dictionary<string, object?>> UpdateFcmProviderAsync(UpdateGuardianFactorsProviderPushNotificationFcmRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request UpdateGuardianFactorsProviderPushNotificationFcmRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<Dictionary<string, object>>

UpdateFcmv1ProviderAsync(UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent, RequestOptions?, CancellationToken)

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

WithRawResponseTask<Dictionary<string, object?>> UpdateFcmv1ProviderAsync(UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<Dictionary<string, object>>

UpdateSnsProviderAsync(UpdateGuardianFactorsProviderPushNotificationSnsRequestContent, RequestOptions?, CancellationToken)

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

WithRawResponseTask<UpdateGuardianFactorsProviderPushNotificationSnsResponseContent> UpdateSnsProviderAsync(UpdateGuardianFactorsProviderPushNotificationSnsRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request UpdateGuardianFactorsProviderPushNotificationSnsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateGuardianFactorsProviderPushNotificationSnsResponseContent>