Class PushNotificationClient

Namespace

Auth0.ManagementApi.Guardian.Factors

Assembly

Auth0.ManagementApi.dll

public class PushNotificationClient : IPushNotificationClient

Inheritance

object

PushNotificationClient

Implements

IPushNotificationClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

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.

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

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderApnsResponseContent>

Examples

await client.Guardian.Factors.PushNotification.GetApnsProviderAsync();

GetSelectedProviderAsync(RequestOptions?, CancellationToken)

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

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

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderPushNotificationResponseContent>

Examples

await client.Guardian.Factors.PushNotification.GetSelectedProviderAsync();

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.

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

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGuardianFactorsProviderSnsResponseContent>

Examples

await client.Guardian.Factors.PushNotification.GetSnsProviderAsync();

SetApnsProviderAsync(SetGuardianFactorsProviderPushNotificationApnsRequestContent, RequestOptions?, CancellationToken)

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

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

Parameters

request SetGuardianFactorsProviderPushNotificationApnsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderPushNotificationApnsResponseContent>

Examples

await client.Guardian.Factors.PushNotification.SetApnsProviderAsync(
    new SetGuardianFactorsProviderPushNotificationApnsRequestContent()
);

SetFcmProviderAsync(SetGuardianFactorsProviderPushNotificationFcmRequestContent, RequestOptions?, CancellationToken)

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

public 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>>

Examples

await client.Guardian.Factors.PushNotification.SetFcmProviderAsync(
    new SetGuardianFactorsProviderPushNotificationFcmRequestContent()
);

SetFcmv1ProviderAsync(SetGuardianFactorsProviderPushNotificationFcmv1RequestContent, RequestOptions?, CancellationToken)

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

public 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>>

Examples

await client.Guardian.Factors.PushNotification.SetFcmv1ProviderAsync(
    new SetGuardianFactorsProviderPushNotificationFcmv1RequestContent()
);

SetProviderAsync(SetGuardianFactorsProviderPushNotificationRequestContent, RequestOptions?, CancellationToken)

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

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

Parameters

request SetGuardianFactorsProviderPushNotificationRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderPushNotificationResponseContent>

Examples

await client.Guardian.Factors.PushNotification.SetProviderAsync(
    new SetGuardianFactorsProviderPushNotificationRequestContent
    {
        Provider = GuardianFactorsProviderPushNotificationProviderDataEnum.Guardian,
    }
);

SetSnsProviderAsync(SetGuardianFactorsProviderPushNotificationSnsRequestContent, RequestOptions?, CancellationToken)

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

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

Parameters

request SetGuardianFactorsProviderPushNotificationSnsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetGuardianFactorsProviderPushNotificationSnsResponseContent>

Examples

await client.Guardian.Factors.PushNotification.SetSnsProviderAsync(
    new SetGuardianFactorsProviderPushNotificationSnsRequestContent()
);

UpdateApnsProviderAsync(UpdateGuardianFactorsProviderPushNotificationApnsRequestContent, RequestOptions?, CancellationToken)

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

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

Parameters

request UpdateGuardianFactorsProviderPushNotificationApnsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateGuardianFactorsProviderPushNotificationApnsResponseContent>

Examples

await client.Guardian.Factors.PushNotification.UpdateApnsProviderAsync(
    new UpdateGuardianFactorsProviderPushNotificationApnsRequestContent()
);

UpdateFcmProviderAsync(UpdateGuardianFactorsProviderPushNotificationFcmRequestContent, RequestOptions?, CancellationToken)

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

public 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>>

Examples

await client.Guardian.Factors.PushNotification.UpdateFcmProviderAsync(
    new UpdateGuardianFactorsProviderPushNotificationFcmRequestContent()
);

UpdateFcmv1ProviderAsync(UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent, RequestOptions?, CancellationToken)

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

public 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>>

Examples

await client.Guardian.Factors.PushNotification.UpdateFcmv1ProviderAsync(
    new UpdateGuardianFactorsProviderPushNotificationFcmv1RequestContent()
);

UpdateSnsProviderAsync(UpdateGuardianFactorsProviderPushNotificationSnsRequestContent, RequestOptions?, CancellationToken)

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

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

Parameters

request UpdateGuardianFactorsProviderPushNotificationSnsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateGuardianFactorsProviderPushNotificationSnsResponseContent>

Examples

await client.Guardian.Factors.PushNotification.UpdateSnsProviderAsync(
    new UpdateGuardianFactorsProviderPushNotificationSnsRequestContent()
);