AttackProtection
extends ManagementEndpoint
in package
implements
AttackProtectionInterface
Class Attack Protection.
Handles requests to the Attack Protection endpoint of the v2 Management API.
Tags
Interfaces, Classes, Traits and Enums
- AttackProtectionInterface
- Interface AttackProtectionInterface.
Table of Contents
- $httpClient : HttpClient
- __construct() : mixed
- ManagementEndpoint constructor.
- getBreachedPasswordDetection() : ResponseInterface
- Get breached password detection settings.
- getBruteForceProtection() : ResponseInterface
- Get the brute force configuration.
- getHttpClient() : HttpClient
- Get the injected HttpClient instance.
- getLastRequest() : HttpRequest|null
- Return an instance of HttpRequest representing the last issued request.
- getResponsePaginator() : HttpResponsePaginator
- Return a ResponsePaginator instance configured for the last HttpRequest.
- getSuspiciousIpThrottling() : ResponseInterface
- Get the suspicious IP throttling configuration.
- instance() : static
- updateBreachedPasswordDetection() : ResponseInterface
- Update breached password detection settings.
- updateBruteForceProtection() : ResponseInterface
- Update the brute force configuration.
- updateSuspiciousIpThrottling() : ResponseInterface
- Update the suspicious IP throttling configuration.
Properties
$httpClient
private
HttpClient
$httpClient
Methods
__construct()
ManagementEndpoint constructor.
public
final __construct(HttpClient $httpClient) : mixed
Parameters
- $httpClient : HttpClient
-
httpClient instance to use
Return values
mixed —getBreachedPasswordDetection()
Get breached password detection settings.
public
getBreachedPasswordDetection([RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:attack_protection.
Parameters
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —getBruteForceProtection()
Get the brute force configuration.
public
getBruteForceProtection([RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:attack_protection.
Parameters
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —getHttpClient()
Get the injected HttpClient instance.
public
final getHttpClient() : HttpClient
Return values
HttpClient —getLastRequest()
Return an instance of HttpRequest representing the last issued request.
public
final getLastRequest() : HttpRequest|null
Return values
HttpRequest|null —getResponsePaginator()
Return a ResponsePaginator instance configured for the last HttpRequest.
public
final getResponsePaginator() : HttpResponsePaginator
Return values
HttpResponsePaginator —getSuspiciousIpThrottling()
Get the suspicious IP throttling configuration.
public
getSuspiciousIpThrottling([RequestOptions|null $options = null ]) : ResponseInterface
Required scope: read:attack_protection.
Parameters
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —instance()
public
static instance(HttpClient $httpClient) : static
Parameters
- $httpClient : HttpClient
Return values
static —updateBreachedPasswordDetection()
Update breached password detection settings.
public
updateBreachedPasswordDetection(array<string|int, mixed> $body[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:attack_protection.
Parameters
- $body : array<string|int, mixed>
-
Body content to pass with the API request. See @see for supported options.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —updateBruteForceProtection()
Update the brute force configuration.
public
updateBruteForceProtection(array<string|int, mixed> $body[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:attack_protection.
Parameters
- $body : array<string|int, mixed>
-
Body content to pass with the API request. See @see for supported options.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)
Return values
ResponseInterface —updateSuspiciousIpThrottling()
Update the suspicious IP throttling configuration.
public
updateSuspiciousIpThrottling(array<string|int, mixed> $body[, RequestOptions|null $options = null ]) : ResponseInterface
Required scope: update:attack_protection.
Parameters
- $body : array<string|int, mixed>
-
Body content to pass with the API request. See @see for supported options.
- $options : RequestOptions|null = null
-
Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)