Auth0Api v1.4.0

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

Documentation for Auth0 Management API of AttackProAuth0.Management.AttackProtection.

endpoint

  • /api/v2/attack-protection/breached-password-detection
  • /api/v2/attack-protection/brute-force-protection
  • /api/v2/attack-protection/suspicious-ip-throttling

Link to this section Summary

Types

config()
error()
response_body()

Functions

get_breached_password_detection(config)

Get breached password detection settings.

get_brute_force_protection(config)

Get the brute force configuration.

get_suspicious_ip_throttling(config)

Get the suspicious IP throttling configuration.

update_breached_password_detection(params, config)

Update breached password detection settings.

update_brute_force_protection(params, config)

Update the brute force configuration.

update_suspicious_ip_throttling(params, config)

Update the suspicious IP throttling configuration.

Link to this section Types

Link to this type

config()

View Source

Specs

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

error()

View Source

Specs

error() :: {:error, integer(), term()} | {:error, term()}
Link to this type

response_body()

View Source

Specs

response_body() :: String.t()

Link to this section Functions

Link to this function

get_breached_password_detection(config)

View Source

Specs

get_breached_password_detection(config()) ::
  {:ok, Auth0.Entity.AttackProtectionBreachedPasswordDetection.t(),
   response_body()}
  | error()

Get breached password detection settings.

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

Specs

get_brute_force_protection(config()) ::
  {:ok, Auth0.Entity.AttackProtectionBruteForceProtection.t(), response_body()}
  | error()

Get the brute force configuration.

see

https://auth0.com/docs/api/management/v2/#!/Attack_Protection/get_brute_force_protection

Link to this function

get_suspicious_ip_throttling(config)

View Source

Specs

get_suspicious_ip_throttling(config()) ::
  {:ok, Auth0.Entity.AttackProtectionSuspiciousIpThrottling.t(),
   response_body()}
  | error()

Get the suspicious IP throttling configuration.

see

https://auth0.com/docs/api/management/v2/#!/Attack_Protection/get_suspicious_ip_throttling

Link to this function

update_breached_password_detection(params, config)

View Source

Specs

update_breached_password_detection(
  Auth0.Management.AttackProtection.BreachedPasswordDetection.Patch.Params.t()
  | map(),
  config()
) ::
  {:ok, Auth0.Entity.AttackProtectionBreachedPasswordDetection.t(),
   response_body()}
  | error()

Update breached password detection settings.

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

Specs

update_brute_force_protection(
  Auth0.Management.AttackProtection.BruteForceProtection.Patch.Params.t()
  | map(),
  config()
) ::
  {:ok, Auth0.Entity.AttackProtectionBruteForceProtection.t(), response_body()}
  | error()

Update the brute force configuration.

see

https://auth0.com/docs/api/management/v2/#!/Attack_Protection/patch_brute_force_protection

Link to this function

update_suspicious_ip_throttling(params, config)

View Source

Specs

update_suspicious_ip_throttling(
  Auth0.Management.AttackProtection.SuspiciousIpThrottling.Patch.Params.t()
  | map(),
  config()
) ::
  {:ok, Auth0.Entity.AttackProtectionSuspiciousIpThrottling.t(),
   response_body()}
  | error()

Update the suspicious IP throttling configuration.

see

https://auth0.com/docs/api/management/v2/#!/Attack_Protection/patch_suspicious_ip_throttling