Auth0.Management.Guardian (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of Guardian.

endpoint

/api/v2/guardian/factors
/api/v2/guardian/policies
/api/v2/guardian/enrollments/{id}
/api/v2/guardian/factors/phone/message-types
/api/v2/guardian/factors/phone/selected-provider
/api/v2/guardian/factors/phone/templates
/api/v2/guardian/factors/sms/selected-provider
/api/v2/guardian/factors/sms/templates
/api/v2/guardian/factors/phone/providers/twilio
/api/v2/guardian/factors/push-notification/providers/sns
/api/v2/guardian/factors/sms/providers/twilio
/api/v2/guardian/enrollments/ticket
/api/v2/guardian/factors/{name}

Link to this section Summary

Types

config()

error()

id()

name()

response_body()

Functions

create_enrollment_ticket(params, config)

Create a multi-factor authentication enrollment ticket.

delete_enrollment(id, config)

Delete a multi-factor authentication enrollment.

get_aws_sns_configuration(config)

Retrieve AWS SNS push notification configuration.

get_enrollment(id, config)

Retrieve a multi-factor authentication enrollment.

get_phone_configuration(config)

Retrieve phone configuration (one of auth0|twilio|phone-message-hook).

get_phone_factor(config)

Retrieve the Enabled Phone Factors.

get_phone_template(config)

Retrieve Enrollment and Verification Phone Templates.

get_sms_configuration(config)

Retrieve SMS configuration (one of auth0|twilio|phone-message-hook).

get_sms_template(config)

Retrieve SMS Enrollment and Verification Templates.

get_twilio_phone_configuration(config)

Retrieve Twilio phone configuration.

get_twilio_sms_configuration(config)

Retrieve Twilio SMS configuration.

list_factors(config)

Retrieve Factors and their Status.

list_policies(config)

Get the Multi-factor Authentication policies.

patch_aws_sns_configuration(params, config)

Update SNS configuration for push notifications.

set_policies(params, config)

Set the Multi-factor Authentication policies.

update_aws_sns_configuration(params, config)

Update AWS SNS push notification configuration.

update_factor(name, params, config)

Update a Multi-factor Authentication Factor.

update_phone_configuration(params, config)

Update phone configuration (one of auth0|twilio|phone-message-hook).

update_phone_factor(params, config)

Update the Enabled Phone Factors.

update_phone_template(params, config)

Update Enrollment and Verification Phone Templates.

update_sms_configuration(params, config)

Update SMS configuration (one of auth0|twilio|phone-message-hook).

update_sms_template(params, config)

Update SMS Enrollment and Verification Templates.

update_twilio_phone_configuration(params, config)

Update Twilio phone configuration.

update_twilio_sms_configuration(params, config)

Update Twilio SMS configuration.

Link to this section Types

config()

Specs

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

error()

Specs

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

id()

Specs

id() :: String.t()

name()

Specs

name() :: String.t()

response_body()

Specs

response_body() :: String.t()

Link to this section Functions

create_enrollment_ticket(params, config)

Specs

create_enrollment_ticket(
  Auth0.Management.Guardian.Enrollments.Ticket.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.GuardianEnrollmentTicket.t(), response_body()} | error()

Create a multi-factor authentication enrollment ticket.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/post_ticket

delete_enrollment(id, config)

Specs

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

Delete a multi-factor authentication enrollment.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/delete_enrollments_by_id

get_aws_sns_configuration(config)

Specs

get_aws_sns_configuration(config()) ::
  {:ok, Auth0.Entity.GuardianAwsSnsConfiguration.t(), response_body()} | error()

Retrieve AWS SNS push notification configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_sns

get_enrollment(id, config)

Specs

get_enrollment(id(), config()) ::
  {:ok, Auth0.Entity.GuardianEnrollment.t(), response_body()} | error()

Retrieve a multi-factor authentication enrollment.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_enrollments_by_id

get_phone_configuration(config)

Specs

get_phone_configuration(config()) ::
  {:ok, Auth0.Entity.GuardianPhoneConfiguration.t(), response_body()} | error()

Retrieve phone configuration (one of auth0|twilio|phone-message-hook).

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_selected_provider

get_phone_factor(config)

Specs

get_phone_factor(config()) ::
  {:ok, Auth0.Entity.GuardianPhoneFactor.t(), response_body()} | error()

Retrieve the Enabled Phone Factors.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_message_types

get_phone_template(config)

Specs

get_phone_template(config()) ::
  {:ok, Auth0.Entity.GuardianPhoneTemplate.t(), response_body()} | error()

Retrieve Enrollment and Verification Phone Templates.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_templates

get_sms_configuration(config)

Specs

get_sms_configuration(config()) ::
  {:ok, Auth0.Entity.GuardianSmsConfiguration.t(), response_body()} | error()

Retrieve SMS configuration (one of auth0|twilio|phone-message-hook).

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_selected_provider_0

get_sms_template(config)

Specs

get_sms_template(config()) ::
  {:ok, Auth0.Entity.GuardianSmsTemplate.t(), response_body()} | error()

Retrieve SMS Enrollment and Verification Templates.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_templates_0

get_twilio_phone_configuration(config)

Specs

get_twilio_phone_configuration(config()) ::
  {:ok, Auth0.Entity.GuardianTwilioConfiguration.t(), response_body()} | error()

Retrieve Twilio phone configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_twilio

get_twilio_sms_configuration(config)

Specs

get_twilio_sms_configuration(config()) ::
  {:ok, Auth0.Entity.GuardianTwilioConfiguration.t(), response_body()} | error()

Retrieve Twilio SMS configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_twilio_0

list_factors(config)

Specs

list_factors(config()) ::
  {:ok, Auth0.Entity.GuardianFactors.t(), response_body()} | error()

Retrieve Factors and their Status.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_factors

list_policies(config)

Specs

list_policies(config()) :: {:ok, [map()], response_body()} | error()

Get the Multi-factor Authentication policies.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/get_policies

patch_aws_sns_configuration(params, config)

Specs

patch_aws_sns_configuration(
  Auth0.Management.Guardian.AwsSns.Configuration.Patch.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.GuardianAwsSnsConfiguration.t(), response_body()} | error()

Update SNS configuration for push notifications.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/patch_sns

set_policies(params, config)

Specs

set_policies(map(), config()) :: {:ok, [map()], response_body()} | error()

Set the Multi-factor Authentication policies.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_policies

update_aws_sns_configuration(params, config)

Specs

update_aws_sns_configuration(
  Auth0.Management.Guardian.AwsSns.Configuration.Put.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.GuardianAwsSnsConfiguration.t(), response_body()} | error()

Update AWS SNS push notification configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_sns

update_factor(name, params, config)

Specs

update_factor(
  name(),
  Auth0.Management.Guardian.Factors.Put.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.GuardianFactor.t(), response_body()} | error()

Update a Multi-factor Authentication Factor.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_factors_by_name

update_phone_configuration(params, config)

Specs

update_phone_configuration(
  Auth0.Management.Guardian.Phone.Configuration.Put.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.GuardianPhoneConfiguration.t(), response_body()} | error()

Update phone configuration (one of auth0|twilio|phone-message-hook).

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_selected_provider

update_phone_factor(params, config)

Specs

update_phone_factor(
  Auth0.Management.Guardian.Phone.Factor.Put.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.GuardianPhoneFactor.t(), response_body()} | error()

Update the Enabled Phone Factors.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_message_types

update_phone_template(params, config)

Specs

update_phone_template(
  Auth0.Management.Guardian.Phone.Template.Put.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.GuardianPhoneTemplate.t(), response_body()} | error()

Update Enrollment and Verification Phone Templates.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_templates

update_sms_configuration(params, config)

Specs

update_sms_configuration(
  Auth0.Management.Guardian.Sms.Configuration.Put.Params.t() | map(),
  config()
) :: {:ok, Auth0.Entity.GuardianSmsConfiguration.t(), response_body()} | error()

Update SMS configuration (one of auth0|twilio|phone-message-hook).

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_selected_provider_0

update_sms_template(params, config)

Specs

update_sms_template(
  Auth0.Management.Guardian.Sms.Template.Put.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.GuardianSmsTemplate.t(), response_body()} | error()

Update SMS Enrollment and Verification Templates.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_templates_0

update_twilio_phone_configuration(params, config)

Specs

update_twilio_phone_configuration(
  Auth0.Management.Guardian.Twilio.Phone.Configuration.Put.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.GuardianTwilioConfiguration.t(), response_body()} | error()

Update Twilio phone configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_twilio

update_twilio_sms_configuration(params, config)

Specs

update_twilio_sms_configuration(
  Auth0.Management.Guardian.Twilio.Sms.Configuration.Put.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.GuardianTwilioConfiguration.t(), response_body()} | error()

Update Twilio SMS configuration.

see

https://auth0.com/docs/api/management/v2/#!/Guardian/put_twilio_0