Class GuardianClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Contains methods to access the /guardian endpoints.

public class GuardianClient : BaseClient, IGuardianClient

Inheritance

object

BaseClient

GuardianClient

Implements

IGuardianClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.BuildUri(string, IList<Tuple<string, string>>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GuardianClient(IManagementConnection, Uri, IDictionary<string, string>)

Initializes a new instance of GuardianClient.

public GuardianClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

IManagementConnection used to make all API calls.

baseUri Uri

Uri of the endpoint to use in making API calls.

defaultHeaders IDictionary<string, string>

Dictionary containing default headers included with every request this client makes.

Methods

CreateEnrollmentTicketAsync(CreateGuardianEnrollmentTicketRequest, CancellationToken)

Create a multi-factor authentication (MFA) enrollment ticket , and optionally send an email with the created ticket, to a given user.

public Task<CreateGuardianEnrollmentTicketResponse> CreateEnrollmentTicketAsync(CreateGuardianEnrollmentTicketRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateGuardianEnrollmentTicketRequest

The CreateGuardianEnrollmentTicketRequest containing the information about the user who should be enrolled.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<CreateGuardianEnrollmentTicketResponse>

A CreateGuardianEnrollmentTicketResponse with the details of the ticket that was created.

DeleteEnrollmentAsync(string, CancellationToken)

Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA. For more information, review Reset User Multi-Factor Authentication and Recovery Codes.

public Task DeleteEnrollmentAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The ID of the enrollment to delete.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

A Task that represents the asynchronous delete operation.

GetDuoConfigurationAsync(CancellationToken)

Retrieves the DUO account and factor configuration.

public Task<DuoConfiguration> GetDuoConfigurationAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<DuoConfiguration>

A DuoConfiguration containing the Duo configuration

GetEnrollmentAsync(string, CancellationToken)

Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account.

public Task<GuardianEnrollment> GetEnrollmentAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The ID of the enrollment to retrieve.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<GuardianEnrollment>

A GuardianEnrollment containing details of the enrollment.

GetFactorsAsync(CancellationToken)

Retrieve details of all multi-factor authentication factors associated with your tenant .

public Task<IList<GuardianFactor>> GetFactorsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IList<GuardianFactor>>

List of GuardianFactor instances with the available factors.

GetMultifactorAuthenticationPolicies(CancellationToken)

Retrieve the multi-factor authentication (MFA) policies configured for your tenant.

public Task<string[]> GetMultifactorAuthenticationPolicies(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<string[]>

MFA authentication policies configured for your tenant

GetPhoneEnrollmentTemplateAsync(CancellationToken)

Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant.

public Task<GuardianPhoneEnrollmentTemplate> GetPhoneEnrollmentTemplateAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<GuardianPhoneEnrollmentTemplate>

A GuardianPhoneEnrollmentTemplate containing the templates.

GetPhoneMessageTypesAsync(CancellationToken)

Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

public Task<GuardianPhoneMessageTypes> GetPhoneMessageTypesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<GuardianPhoneMessageTypes>

A GuardianPhoneMessageTypes containing the message types.

GetPhoneProviderConfigurationAsync(CancellationToken)

Retrieve details of the multi-factor authentication phone provider configured for your tenant.

public Task<PhoneProviderConfiguration> GetPhoneProviderConfigurationAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<PhoneProviderConfiguration>

PhoneProviderConfiguration

GetPushNotificationApnsProviderConfigurationAsync(CancellationToken)

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

public Task<PushNotificationApnsConfiguration> GetPushNotificationApnsProviderConfigurationAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<PushNotificationApnsConfiguration>

A PushNotificationApnsConfiguration containing the details regarding APNS Push Notification Provider configuration.

GetPushNotificationProviderConfigurationAsync(CancellationToken)

Retrieve details of the push-notification providers configured for your tenant.

public Task<PushNotificationProviderConfiguration> GetPushNotificationProviderConfigurationAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<PushNotificationProviderConfiguration>

PushNotificationProviderConfiguration

GetSmsTemplatesAsync(CancellationToken)

Retrieves enrollment and verification templates. You can use it to check the current values for your templates.

public Task<GuardianSmsEnrollmentTemplates> GetSmsTemplatesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<GuardianSmsEnrollmentTemplates>

A GuardianSmsEnrollmentTemplates containing the templates.

GetSnsConfigurationAsync(CancellationToken)

Returns provider configuration for AWS SNS.

public Task<GuardianSnsConfiguration> GetSnsConfigurationAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<GuardianSnsConfiguration>

A GuardianSnsConfiguration containing Amazon SNS configuration.

GetTwilioConfigurationAsync(CancellationToken)

Retrieve configuration details for a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA.

public Task<GuardianTwilioConfiguration> GetTwilioConfigurationAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<GuardianTwilioConfiguration>

GuardianTwilioConfiguration with the Twilio configuration.

UpdateDuoConfigurationAsync(DuoConfigurationPatchRequest, CancellationToken)

Update the DUO Configuration using PATCH

public Task<DuoConfiguration> UpdateDuoConfigurationAsync(DuoConfigurationPatchRequest configuration, CancellationToken cancellationToken = default)

Parameters

configuration DuoConfigurationPatchRequest

DuoConfigurationPatchRequest

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<DuoConfiguration>

DuoConfiguration containing the updated configuration

UpdateDuoConfigurationAsync(DuoConfigurationPutRequest, CancellationToken)

Update the DUO Configuration using PUT

public Task<DuoConfiguration> UpdateDuoConfigurationAsync(DuoConfigurationPutRequest configuration, CancellationToken cancellationToken = default)

Parameters

configuration DuoConfigurationPutRequest

DuoConfigurationPatchRequest

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<DuoConfiguration>

DuoConfiguration containing the updated configuration

UpdateFactorAsync(UpdateGuardianFactorRequest, CancellationToken)

Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.

public Task<UpdateGuardianFactorResponse> UpdateFactorAsync(UpdateGuardianFactorRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateGuardianFactorRequest

The UpdateGuardianFactorRequest containing the details of the factor to update.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<UpdateGuardianFactorResponse>

The UpdateGuardianFactorResponse indicating the status of the factor.

UpdateMultifactorAuthenticationPolicies(string[], CancellationToken)

Set the multi-factor authentication (MFA) policies for your tenant.

public Task<string[]> UpdateMultifactorAuthenticationPolicies(string[] mfaPolicies, CancellationToken cancellationToken = default)

Parameters

mfaPolicies string[]

MFA policies to update

cancellationToken CancellationToken

Returns

Task<string[]>

MFA policies configured for your tenant

UpdatePhoneEnrollmentTemplateAsync(GuardianPhoneEnrollmentTemplate, CancellationToken)

Customize the messages sent to complete phone enrollment and verification (subscription required).

public Task<GuardianPhoneEnrollmentTemplate> UpdatePhoneEnrollmentTemplateAsync(GuardianPhoneEnrollmentTemplate phoneEnrollmentTemplate, CancellationToken cancellationToken = default)

Parameters

phoneEnrollmentTemplate GuardianPhoneEnrollmentTemplate

A GuardianPhoneEnrollmentTemplate containing the template to be udpated.

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<GuardianPhoneEnrollmentTemplate>

A GuardianPhoneEnrollmentTemplate containing the templates.

UpdatePhoneMessageTypesAsync(GuardianPhoneMessageTypes, CancellationToken)

Replace the list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

public Task<GuardianPhoneMessageTypes> UpdatePhoneMessageTypesAsync(GuardianPhoneMessageTypes messageTypes, CancellationToken cancellationToken = default)

Parameters

messageTypes GuardianPhoneMessageTypes

A GuardianPhoneMessageTypes containing the list of phone factors to enable on the tenant.

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<GuardianPhoneMessageTypes>

A GuardianPhoneMessageTypes containing the message types.

UpdatePhoneProviderConfigurationAsync(PhoneProviderConfiguration, CancellationToken)

Update Phone provider configuration.

public Task<PhoneProviderConfiguration> UpdatePhoneProviderConfigurationAsync(PhoneProviderConfiguration phoneProviderConfiguraiton, CancellationToken cancellationToken = default)

Parameters

phoneProviderConfiguraiton PhoneProviderConfiguration

PhoneProviderConfiguration - Containing the configuration information to be updated

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<PhoneProviderConfiguration>

PhoneProviderConfiguration

UpdatePushNotificationApnsProviderConfigurationAsync(PushNotificationApnsConfigurationPatchUpdateRequest, CancellationToken)

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

public Task<PushNotificationApnsConfigurationUpdateResponse> UpdatePushNotificationApnsProviderConfigurationAsync(PushNotificationApnsConfigurationPatchUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request PushNotificationApnsConfigurationPatchUpdateRequest

PushNotificationApnsConfigurationPatchUpdateRequest

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<PushNotificationApnsConfigurationUpdateResponse>

A PushNotificationApnsConfigurationUpdateResponse

UpdatePushNotificationApnsProviderConfigurationAsync(PushNotificationApnsConfigurationPutUpdateRequest, CancellationToken)

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

public Task<PushNotificationApnsConfigurationUpdateResponse> UpdatePushNotificationApnsProviderConfigurationAsync(PushNotificationApnsConfigurationPutUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request PushNotificationApnsConfigurationPutUpdateRequest

PushNotificationApnsConfigurationPutUpdateRequest

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<PushNotificationApnsConfigurationUpdateResponse>

A PushNotificationApnsConfigurationUpdateResponse

UpdatePushNotificationFcmConfigurationAsync(FcmConfigurationPatchUpdateRequest, CancellationToken)

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

public Task<object> UpdatePushNotificationFcmConfigurationAsync(FcmConfigurationPatchUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request FcmConfigurationPatchUpdateRequest

FcmConfigurationPatchUpdateRequest

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<object>

An object containing information about the FCM configuration

UpdatePushNotificationFcmConfigurationAsync(FcmConfigurationPutUpdateRequest, CancellationToken)

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

public Task<object> UpdatePushNotificationFcmConfigurationAsync(FcmConfigurationPutUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request FcmConfigurationPutUpdateRequest

FcmConfigurationPutUpdateRequest

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<object>

UpdatePushNotificationFcmV1ConfigurationAsync(FcmV1ConfigurationPatchUpdateRequest, CancellationToken)

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

public Task<object> UpdatePushNotificationFcmV1ConfigurationAsync(FcmV1ConfigurationPatchUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request FcmV1ConfigurationPatchUpdateRequest

FcmV1ConfigurationPatchUpdateRequest

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<object>

An object containing information about the FCMV1 configuration

UpdatePushNotificationFcmV1ConfigurationAsync(FcmV1ConfigurationPutUpdateRequest, CancellationToken)

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

public Task<object> UpdatePushNotificationFcmV1ConfigurationAsync(FcmV1ConfigurationPutUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request FcmV1ConfigurationPutUpdateRequest

FcmV1ConfigurationPutUpdateRequest

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<object>

An object containing information about the FCMV1 configuration

UpdatePushNotificationProviderConfigurationAsync(PushNotificationProviderConfiguration, CancellationToken)

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

public Task<PushNotificationProviderConfiguration> UpdatePushNotificationProviderConfigurationAsync(PushNotificationProviderConfiguration pushNotificationProviderConfiguration, CancellationToken cancellationToken = default)

Parameters

pushNotificationProviderConfiguration PushNotificationProviderConfiguration

PushNotificationProviderConfiguration - Containing the configuration information to be updated

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<PushNotificationProviderConfiguration>

PushNotificationProviderConfiguration

UpdatePushNotificationSnsConfigurationAsync(GuardianSnsConfigurationPatchUpdateRequest, CancellationToken)

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

public Task<GuardianSnsConfiguration> UpdatePushNotificationSnsConfigurationAsync(GuardianSnsConfigurationPatchUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request GuardianSnsConfigurationPatchUpdateRequest

GuardianSnsConfigurationPatchUpdateRequest

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<GuardianSnsConfiguration>

A GuardianSnsConfiguration containing information about the SNS configuration

UpdatePushNotificationSnsConfigurationAsync(GuardianSnsConfigurationPutUpdateRequest, CancellationToken)

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

public Task<GuardianSnsConfiguration> UpdatePushNotificationSnsConfigurationAsync(GuardianSnsConfigurationPutUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request GuardianSnsConfigurationPutUpdateRequest

GuardianSnsConfigurationPutUpdateRequest

cancellationToken CancellationToken

CancellationToken The cancellation token to cancel operation.

Returns

Task<GuardianSnsConfiguration>

A GuardianSnsConfiguration containing information about the SNS configuration

UpdateSmsTemplatesAsync(GuardianSmsEnrollmentTemplates, CancellationToken)

Updates enrollment and verification templates. Useful to send custom messages on SMS enrollment and verification.

public Task<GuardianSmsEnrollmentTemplates> UpdateSmsTemplatesAsync(GuardianSmsEnrollmentTemplates templates, CancellationToken cancellationToken = default)

Parameters

templates GuardianSmsEnrollmentTemplates

A GuardianSmsEnrollmentTemplates containing the updated templates.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<GuardianSmsEnrollmentTemplates>

A GuardianSmsEnrollmentTemplates containing the templates.

UpdateTwilioConfigurationAsync(UpdateGuardianTwilioConfigurationRequest, CancellationToken)

Update the configuration of a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA.

public Task<GuardianTwilioConfiguration> UpdateTwilioConfigurationAsync(UpdateGuardianTwilioConfigurationRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateGuardianTwilioConfigurationRequest

The UpdateGuardianTwilioConfigurationRequest containing the configuration settings.

cancellationToken CancellationToken

CancellationToken - The cancellation token to cancel operation.

Returns

Task<GuardianTwilioConfiguration>

The GuardianTwilioConfiguration containing the updated configuration settings.