Class AttackProtectionManager

Hierarchy

BaseAPI
- AttackProtectionManager

Index

Constructors

Properties

Methods

getBreachedPasswordDetectionConfig getBruteForceConfig getSuspiciousIpThrottlingConfig request updateBreachedPasswordDetectionConfig updateBruteForceConfig updateSuspiciousIpThrottlingConfig

Constructors

constructor

new AttackProtectionManager(configuration): AttackProtectionManager
Parameters
- configuration: Configuration
Returns AttackProtectionManager
Inherited from BaseAPI.constructor
- Defined in src/lib/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration

Methods

getBreachedPasswordDetectionConfig

getBreachedPasswordDetectionConfig(initOverrides?): Promise<ApiResponse<GetBreachedPasswordDetection200Response>>
Get breached password detection settings

Throws
Parameters
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetBreachedPasswordDetection200Response>>
- Defined in src/management/__generated/managers/attack-protection-manager.ts:23

getBruteForceConfig

getBruteForceConfig(initOverrides?): Promise<ApiResponse<GetBruteForceProtection200Response>>
Get the brute force configuration

Throws
Parameters
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetBruteForceProtection200Response>>
- Defined in src/management/__generated/managers/attack-protection-manager.ts:42

getSuspiciousIpThrottlingConfig

getSuspiciousIpThrottlingConfig(initOverrides?): Promise<ApiResponse<GetSuspiciousIpThrottling200Response>>
Get the suspicious IP throttling configuration

Throws
Parameters
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetSuspiciousIpThrottling200Response>>
- Defined in src/management/__generated/managers/attack-protection-manager.ts:61

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/lib/runtime.ts:40

updateBreachedPasswordDetectionConfig

updateBreachedPasswordDetectionConfig(bodyParameters, initOverrides?): Promise<ApiResponse<GetBreachedPasswordDetection200Response>>
Update breached password detection settings

Throws
Parameters
- bodyParameters: PatchBreachedPasswordDetectionRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetBreachedPasswordDetection200Response>>
- Defined in src/management/__generated/managers/attack-protection-manager.ts:80

updateBruteForceConfig

updateBruteForceConfig(bodyParameters, initOverrides?): Promise<ApiResponse<GetBruteForceProtection200Response>>
Update the brute force configuration

Throws
Parameters
- bodyParameters: PatchBruteForceProtectionRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetBruteForceProtection200Response>>
- Defined in src/management/__generated/managers/attack-protection-manager.ts:106

updateSuspiciousIpThrottlingConfig

updateSuspiciousIpThrottlingConfig(bodyParameters, initOverrides?): Promise<ApiResponse<GetSuspiciousIpThrottling200Response>>
Update the suspicious IP throttling configuration

Throws
Parameters
- bodyParameters: PatchSuspiciousIpThrottlingRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetSuspiciousIpThrottling200Response>>
- Defined in src/management/__generated/managers/attack-protection-manager.ts:132