Constructor
+ + +new AttackProtectionManager(options)
+ + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +Name | + + +Type | + + + + + +Description | +||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+
+
+
+
+ The client options. + + + +
|
+
Methods
+ + + +getBreachedPasswordDetectionConfig(params, cbopt) → {Promise|undefined}
+ + + + + +Get the Breached Password Detection configuration.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +Name | + + +Type | + + +Attributes | + + + + +Description | +
---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Breached password detection parameters (leave empty). + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise
+| + +undefined
+ + +
+
Example
+ +management.attackProtection.getBreachedPasswordDetectionConfig(params, function (err, breachedPasswordDetectionConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Access breached password detection configuration
+ console.log(breachedPasswordDetectionConfig);
+});
+
+getBruteForceConfig(params, cbopt) → {Promise|undefined}
+ + + + + +Get the Brute Force Protection configuration.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +Name | + + +Type | + + +Attributes | + + + + +Description | +
---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Brute force parameters (leave empty). + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise
+| + +undefined
+ + +
+
Example
+ +management.attackProtection.getBruteForceConfig(params, function (err, bruteForceConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Brute force config
+ console.log(bruteForceConfig);
+});
+
+getSuspiciousIpThrottlingConfig(params, cbopt) → {Promise|undefined}
+ + + + + +Get the Suspicious IP Throttling configuration.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +Name | + + +Type | + + +Attributes | + + + + +Description | +
---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Suspicious IP throttling parameters (leave empty). + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise
+| + +undefined
+ + +
+
Example
+ +management.attackProtection.getSuspiciousIpThrottlingConfig(params, function (err, suspiciousIpThrottlingConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Access suspicious IP throttling configuration
+ console.log(suspiciousIpThrottlingConfig);
+});
+
+updateBreachedPasswordDetectionConfig(params, data, cbopt) → {Promise|undefined}
+ + + + + +Update the breached password detection configuration.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +Name | + + +Type | + + +Attributes | + + + + +Description | +
---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Breached password detection parameters (leave empty). + + |
+
data |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated breached password detection configuration. + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise
+| + +undefined
+ + +
+
Example
+ +management.attackProtection.updateBreachedPasswordDetectionConfig(params, data, function (err, breachedPasswordDetectionConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Access breached password detection configuration
+ console.log(breachedPasswordDetectionConfig);
+});
+
+updateBruteForceConfig(params, data, cbopt) → {Promise|undefined}
+ + + + + +Update the Brute Force Protection configuration.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +Name | + + +Type | + + +Attributes | + + + + +Description | +
---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Brute force parameters (leave empty). + + |
+
data |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated brute force configuration. + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise
+| + +undefined
+ + +
+
Example
+ +management.attackProtection.updateBruteForceConfig(params, data, function (err, bruteForceConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Brute force config
+ console.log(bruteForceConfig);
+});
+
+updateSuspiciousIpThrottlingConfig(params, data, cbopt) → {Promise|undefined}
+ + + + + +Update the Suspicious IP Throttling configuration.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + + + +
Parameters:
+ + +Name | + + +Type | + + +Attributes | + + + + +Description | +
---|---|---|---|
params |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Suspicious IP throttling parameters (leave empty). + + |
+
data |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ Updated suspicious IP throttling configuration. + + |
+
cb |
+
+
+
+
+
+function
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ Callback function. + + |
+
Returns:
+ + + +-
+
- + Type: + +
-
+
+
Promise
+| + +undefined
+ + +
+
Example
+ +management.attackProtection.updateSuspiciousIpThrottlingConfig(params, data, function (err, suspiciousIpThrottlingConfig) {
+ if (err) {
+ // Handle error.
+ }
+
+ // Access suspicious IP throttling configuration
+ console.log(suspiciousIpThrottlingConfig);
+});
+
+