Module: Auth0::Api::V2::AttackProtection

Included in:

Auth0::Api::V2

Defined in:

lib/auth0/api/v2/attack_protection.rb

Overview

Methods to use the attack-protection endpoints

Instance Method Summary

• #breached_password_detection ⇒ json (also: #get_breached_password_detection_settings)

  Get breached password detection settings.

• #brute_force_protection ⇒ json (also: #get_brute_force_protection_settings)

  Get brute force protection settings.

• #patch_breached_password_detection(body) ⇒ json (also: #update_breached_password_detection_settings)

  Update breached password detection settings.

• #patch_brute_force_protection(body) ⇒ json (also: #update_brute_force_protection_settings)

  Update brute force protection settings.

• #patch_suspicious_ip_throttling(body) ⇒ Object (also: #update_suspicious_ip_throttling_settings)

  Update suspicious IP throttling settings.

• #suspicious_ip_throttling ⇒ Object (also: #get_suspicious_ip_throttling_settings)

  Get suspicious IP throttling settings.

Instance Method Details

#breached_password_detection ⇒ json Also known as: get_breached_password_detection_settings

Get breached password detection settings

Returns:

• (json) —

  The configuration for breached password detection

See Also:

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

# File 'lib/auth0/api/v2/attack_protection.rb', line 11

def breached_password_detection
  get(breached_password_settings_path)
end

#brute_force_protection ⇒ json Also known as: get_brute_force_protection_settings

Get brute force protection settings.

Returns:

• (json) —

  The configuration for brute force protection

See Also:

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

# File 'lib/auth0/api/v2/attack_protection.rb', line 27

def brute_force_protection
  get(brute_force_protection_settings_path)
end

#patch_breached_password_detection(body) ⇒ json Also known as: update_breached_password_detection_settings

Update breached password detection settings

Parameters:

• body (hash) —

  See auth0.com/docs/api/management/v2#!/Attack_Protection/patch_breached_password_detection for available options

Returns:

• (json) —

  The configuration for breached password detection

See Also:

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

# File 'lib/auth0/api/v2/attack_protection.rb', line 20

def patch_breached_password_detection(body)
  patch(breached_password_settings_path, body)
end

#patch_brute_force_protection(body) ⇒ json Also known as: update_brute_force_protection_settings

Update brute force protection settings.

Parameters:

• body (hash) —

  See auth0.com/docs/api/management/v2#!/Attack_Protection/patch_brute_force_protection for available options

Returns:

• (json) —

  The configuration for brute force protection

See Also:

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

# File 'lib/auth0/api/v2/attack_protection.rb', line 36

def patch_brute_force_protection(body)
  patch(brute_force_protection_settings_path, body)
end

#patch_suspicious_ip_throttling(body) ⇒ Object Also known as: update_suspicious_ip_throttling_settings

Update suspicious IP throttling settings

Parameters:

• body (hash) —

  See auth0.com/docs/api/management/v2#!/Attack_Protection/patch_suspicious_ip_throttling for available options

Returns:

• The configuration for suspicious IP throttling

See Also:

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

# File 'lib/auth0/api/v2/attack_protection.rb', line 53

def patch_suspicious_ip_throttling(body)
  patch(suspicious_ip_throttling_settings_path, body)
end

#suspicious_ip_throttling ⇒ Object Also known as: get_suspicious_ip_throttling_settings

Get suspicious IP throttling settings

Returns:

• The configuration for suspicious IP throttling

See Also:

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

# File 'lib/auth0/api/v2/attack_protection.rb', line 44

def suspicious_ip_throttling
  get(suspicious_ip_throttling_settings_path)
end