View Source Auth0.Management.AttackProtection (Auth0Api v2.5.0)

Facade for the Auth0 Management API Attack Protection endpoints.

Most applications should call Auth0.Api.Management instead of this module.

Summary

Types

config()
error()

Functions

get_bot_detection(config)

Retrieve details of the Bot Detection configuration of your tenant.

get_breached_password_detection(config)

Retrieve details of the Breached Password Detection configuration of your tenant.

get_brute_force_protection(config)

Retrieve details of the Brute-force Protection configuration of your tenant.

get_captcha(config)

Get the CAPTCHA configuration for a tenant.

get_phone_provider_protection(config)

Get Phone Provider Protection settings.

get_suspicious_ip_throttling(config)

Retrieve details of the Suspicious IP Throttling configuration of your tenant.

update_bot_detection(params, config)

Update details of the Bot Detection configuration of your tenant.

update_breached_password_detection(params, config)

Update details of the Breached Password Detection configuration of your tenant.

update_brute_force_protection(params, config)

Update the Brute-force Protection configuration of your tenant.

update_captcha(params, config)

Partial Update for CAPTCHA Configuration.

update_phone_provider_protection(params, config)

Update Phone Provider Protection settings.

update_suspicious_ip_throttling(params, config)

Update the details of the Suspicious IP Throttling configuration of your tenant.

Types

Link to this type

config()

View Source 
@type config() :: Auth0.Config.t()
Link to this type

error()

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

Functions

Link to this function

get_bot_detection(config)

View Source 
@spec get_bot_detection(config()) :: {:ok, map()} | error()

Retrieve details of the Bot Detection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-bot-detection

Link to this function

get_breached_password_detection(config)

View Source 
@spec get_breached_password_detection(config()) :: {:ok, map()} | error()

Retrieve details of the Breached Password Detection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-breached-password-detection

Link to this function

get_brute_force_protection(config)

View Source 
@spec get_brute_force_protection(config()) :: {:ok, map()} | error()

Retrieve details of the Brute-force Protection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-brute-force-protection

Link to this function

get_captcha(config)

View Source 
@spec get_captcha(config()) :: {:ok, map()} | error()

Get the CAPTCHA configuration for a tenant.

Get the CAPTCHA configuration for your client.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-captcha

Link to this function

get_phone_provider_protection(config)

View Source 
@spec get_phone_provider_protection(config()) :: {:ok, map()} | error()

Get Phone Provider Protection settings.

Get the phone provider protection configuration for a tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-phone-provider-protection

Link to this function

get_suspicious_ip_throttling(config)

View Source 
@spec get_suspicious_ip_throttling(config()) :: {:ok, map()} | error()

Retrieve details of the Suspicious IP Throttling configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/get-suspicious-ip-throttling

Link to this function

update_bot_detection(params, config)

View Source 
@spec update_bot_detection(map(), config()) :: {:ok, map()} | error()

Update details of the Bot Detection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-bot-detection

Link to this function

update_breached_password_detection(params, config)

View Source 
@spec update_breached_password_detection(
  map(),
  config()
) :: {:ok, map()} | error()

Update details of the Breached Password Detection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-breached-password-detection

Link to this function

update_brute_force_protection(params, config)

View Source 
@spec update_brute_force_protection(map(), config()) :: {:ok, map()} | error()

Update the Brute-force Protection configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-brute-force-protection

Link to this function

update_captcha(params, config)

View Source 
@spec update_captcha(map(), config()) :: {:ok, map()} | error()

Partial Update for CAPTCHA Configuration.

Update existing CAPTCHA configuration for your client.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-captcha

Link to this function

update_phone_provider_protection(params, config)

View Source 
@spec update_phone_provider_protection(map(), config()) :: {:ok, map()} | error()

Update Phone Provider Protection settings.

Update the phone provider protection configuration for a tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-phone-provider-protection

Link to this function

update_suspicious_ip_throttling(params, config)

View Source 
@spec update_suspicious_ip_throttling(map(), config()) :: {:ok, map()} | error()

Update the details of the Suspicious IP Throttling configuration of your tenant.

see

https://auth0.com/docs/api/management/v2/attack-protection/patch-suspicious-ip-throttling