View Source Auth0.Management.Guardian (Auth0Api v2.2.0)

Summary

Types

config()

error()

id()

name()

Functions

create_enrollment_ticket(params, config)

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

delete_enrollment(id, config)

Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA.

get_apns_configuration(config)

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

get_aws_sns_configuration(config)

Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA.

get_enrollment(id, config)

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

get_notification_provider(config)

Retrieve the push notification provider configured for your tenant.

get_phone_configuration(config)

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

get_phone_factor(config)

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

get_phone_template(config)

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

get_twilio_phone_configuration(config)

Retrieve configuration details for a Twilio phone provider that has been set up in your tenant.

list_factors(config)

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

list_policies(config)

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

patch_apns_configuration(params, config)

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

patch_aws_sns_configuration(params, config)

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

patch_fcm_configuration(params, config)

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

patch_fcmv1_configuration(params, config)

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

set_policies(params, config)

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

update_apns_configuration(params, config)

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

update_aws_sns_configuration(params, config)

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

update_factor(name, params, config)

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

update_fcm_configuration(params, config)

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

update_fcmv1_configuration(params, config)

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

update_notification_provider(params, config)

Modify the push notification provider configured for your tenant.

update_phone_configuration(params, config)

Update phone provider configuration

update_phone_factor(params, config)

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

update_phone_template(params, config)

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

update_twilio_phone_configuration(params, config)

Update the configuration of a Twilio phone provider that has been set up in your tenant.

Types

config()

@type config() :: Auth0.Config.t()

error()

@type error() :: {:error, integer(), term()} | {:error, term()}

id()

@type id() :: String.t()

name()

@type name() :: String.t()

Functions

create_enrollment_ticket(params, config)

@spec create_enrollment_ticket(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/post-ticket

delete_enrollment(id, config)

@spec delete_enrollment(id(), config()) :: {:ok, String.t()} | error()

Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA.

see

https://auth0.com/docs/api/management/v2/guardian/delete-enrollments-by-id

get_apns_configuration(config)

@spec get_apns_configuration(config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/get-apns

get_aws_sns_configuration(config)

@spec get_aws_sns_configuration(config()) :: {:ok, map()} | error()

Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA.

see

https://auth0.com/docs/api/management/v2/guardian/get-sns

get_enrollment(id, config)

@spec get_enrollment(id(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/get-enrollments-by-id

get_notification_provider(config)

@spec get_notification_provider(config()) :: {:ok, map()} | error()

Retrieve the push notification provider configured for your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/get-pn-providers

get_phone_configuration(config)

@spec get_phone_configuration(config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/get-guardian-phone-providers

get_phone_factor(config)

@spec get_phone_factor(config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/get-message-types

get_phone_template(config)

@spec get_phone_template(config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/get-factor-phone-templates

get_twilio_phone_configuration(config)

@spec get_twilio_phone_configuration(config()) :: {:ok, map()} | error()

Retrieve configuration details for a Twilio phone provider that has been set up in your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/get-phone-twilio-factor-provider

list_factors(config)

@spec list_factors(config()) :: {:ok, [map()]} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/get-factors

list_policies(config)

@spec list_policies(config()) :: {:ok, list()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/get-policies

patch_apns_configuration(params, config)

@spec patch_apns_configuration(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/patch-apns

patch_aws_sns_configuration(params, config)

@spec patch_aws_sns_configuration(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/patch-sns

patch_fcm_configuration(params, config)

@spec patch_fcm_configuration(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/patch-fcm

patch_fcmv1_configuration(params, config)

@spec patch_fcmv1_configuration(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/patch-fcmv-1

set_policies(params, config)

@spec set_policies(map(), config()) :: {:ok, list()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/put-policies

update_apns_configuration(params, config)

@spec update_apns_configuration(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/put-apns

update_aws_sns_configuration(params, config)

@spec update_aws_sns_configuration(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/put-sns

update_factor(name, params, config)

@spec update_factor(name(), map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/put-factors-by-name

update_fcm_configuration(params, config)

@spec update_fcm_configuration(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/put-fcm

update_fcmv1_configuration(params, config)

@spec update_fcmv1_configuration(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/put-fcmv-1

update_notification_provider(params, config)

@spec update_notification_provider(map(), config()) :: {:ok, map()} | error()

Modify the push notification provider configured for your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/put-pn-providers

update_phone_configuration(params, config)

@spec update_phone_configuration(map(), config()) :: {:ok, map()} | error()

Update phone provider configuration

see

https://auth0.com/docs/api/management/v2/guardian/put-phone-providers

update_phone_factor(params, config)

@spec update_phone_factor(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/put-message-types

update_phone_template(params, config)

@spec update_phone_template(map(), config()) :: {:ok, map()} | error()

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

see

https://auth0.com/docs/api/management/v2/guardian/put-factor-phone-templates

update_twilio_phone_configuration(params, config)

@spec update_twilio_phone_configuration(map(), config()) :: {:ok, map()} | error()

Update the configuration of a Twilio phone provider that has been set up in your tenant.

see

https://auth0.com/docs/api/management/v2/guardian/put-twilio