Skip to content

feat: add Bot Detection and CAPTCHA attack protection endpoints #1235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
developerkunal merged 1 commit into from
Nov 4, 2025
Merged

feat: add Bot Detection and CAPTCHA attack protection endpoints #1235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
240 changes: 240 additions & 0 deletions reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11018,6 +11018,126 @@ await client.anomaly.blocks.unblockIp("id");
</dl>
</details>

## AttackProtection BotDetection

<details><summary><code>client.attackProtection.botDetection.<a href="/src/management/api/resources/attackProtection/resources/botDetection/client/Client.ts">get</a>() -> Management.GetBotDetectionSettingsResponseContent</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get the Bot Detection configuration of your tenant.

</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.attackProtection.botDetection.get();
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `BotDetection.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

<details><summary><code>client.attackProtection.botDetection.<a href="/src/management/api/resources/attackProtection/resources/botDetection/client/Client.ts">update</a>({ ...params }) -> Management.UpdateBotDetectionSettingsResponseContent</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the Bot Detection configuration of your tenant.

</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.attackProtection.botDetection.update();
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Management.UpdateBotDetectionSettingsRequestContent`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `BotDetection.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

## AttackProtection BreachedPasswordDetection

<details><summary><code>client.attackProtection.breachedPasswordDetection.<a href="/src/management/api/resources/attackProtection/resources/breachedPasswordDetection/client/Client.ts">get</a>() -> Management.GetBreachedPasswordDetectionSettingsResponseContent</code></summary>
Expand Down Expand Up @@ -11258,6 +11378,126 @@ await client.attackProtection.bruteForceProtection.update();
</dl>
</details>

## AttackProtection Captcha

<details><summary><code>client.attackProtection.captcha.<a href="/src/management/api/resources/attackProtection/resources/captcha/client/Client.ts">get</a>() -> Management.GetAttackProtectionCaptchaResponseContent</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get the CAPTCHA configuration for your client.

</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.attackProtection.captcha.get();
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**requestOptions:** `Captcha.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

<details><summary><code>client.attackProtection.captcha.<a href="/src/management/api/resources/attackProtection/resources/captcha/client/Client.ts">update</a>({ ...params }) -> Management.UpdateAttackProtectionCaptchaResponseContent</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update existing CAPTCHA configuration for your client.

</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```typescript
await client.attackProtection.captcha.update();
```

</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `Management.UpdateAttackProtectionCaptchaRequestContent`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `Captcha.RequestOptions`

</dd>
</dl>
</dd>
</dl>

</dd>
</dl>
</details>

## AttackProtection SuspiciousIpThrottling

<details><summary><code>client.attackProtection.suspiciousIpThrottling.<a href="/src/management/api/resources/attackProtection/resources/suspiciousIpThrottling/client/Client.ts">get</a>() -> Management.GetSuspiciousIpThrottlingSettingsResponseContent</code></summary>
Expand Down
28 changes: 28 additions & 0 deletions src/management/api/requests/requests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1763,6 +1763,19 @@ export interface UpdateActionBindingsRequestContent {
bindings?: Management.ActionBindingWithRef[];
}

/**
* @example
* {}
*/
export interface UpdateBotDetectionSettingsRequestContent {
bot_detection_level?: Management.BotDetectionLevelEnum;
challenge_password_policy?: Management.BotDetectionChallengePolicyPasswordFlowEnum;
challenge_passwordless_policy?: Management.BotDetectionChallengePolicyPasswordlessFlowEnum;
challenge_password_reset_policy?: Management.BotDetectionChallengePolicyPasswordResetFlowEnum;
allowlist?: Management.BotDetectionAllowlist;
monitoring_mode_enabled?: Management.BotDetectionMonitoringModeEnabled;
}

/**
* @example
* {}
Expand Down Expand Up @@ -1829,6 +1842,21 @@ export namespace UpdateBruteForceSettingsRequestContent {
export type Mode = (typeof Mode)[keyof typeof Mode];
}

/**
* @example
* {}
*/
export interface UpdateAttackProtectionCaptchaRequestContent {
active_provider_id?: Management.AttackProtectionCaptchaProviderId;
arkose?: Management.AttackProtectionUpdateCaptchaArkose;
auth_challenge?: Management.AttackProtectionCaptchaAuthChallengeRequest;
hcaptcha?: Management.AttackProtectionUpdateCaptchaHcaptcha;
friendly_captcha?: Management.AttackProtectionUpdateCaptchaFriendlyCaptcha;
recaptcha_enterprise?: Management.AttackProtectionUpdateCaptchaRecaptchaEnterprise;
recaptcha_v2?: Management.AttackProtectionUpdateCaptchaRecaptchaV2;
simple_captcha?: Management.AttackProtectionCaptchaSimpleCaptchaResponseContent;
}

/**
* @example
* {}
Expand Down
12 changes: 12 additions & 0 deletions src/management/api/resources/attackProtection/client/Client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
import type { BaseClientOptions } from "../../../../BaseClient.js";
import * as environments from "../../../../environments.js";
import * as core from "../../../../core/index.js";
import { BotDetection } from "../resources/botDetection/client/Client.js";
import { BreachedPasswordDetection } from "../resources/breachedPasswordDetection/client/Client.js";
import { BruteForceProtection } from "../resources/bruteForceProtection/client/Client.js";
import { Captcha } from "../resources/captcha/client/Client.js";
import { SuspiciousIpThrottling } from "../resources/suspiciousIpThrottling/client/Client.js";

export declare namespace AttackProtection {
Expand All @@ -13,14 +15,20 @@ export declare namespace AttackProtection {

export class AttackProtection {
protected readonly _options: AttackProtection.Options;
protected _botDetection: BotDetection | undefined;
protected _breachedPasswordDetection: BreachedPasswordDetection | undefined;
protected _bruteForceProtection: BruteForceProtection | undefined;
protected _captcha: Captcha | undefined;
protected _suspiciousIpThrottling: SuspiciousIpThrottling | undefined;

constructor(_options: AttackProtection.Options) {
this._options = _options;
}

public get botDetection(): BotDetection {
return (this._botDetection ??= new BotDetection(this._options));
}

public get breachedPasswordDetection(): BreachedPasswordDetection {
return (this._breachedPasswordDetection ??= new BreachedPasswordDetection(this._options));
}
Expand All @@ -29,6 +37,10 @@ export class AttackProtection {
return (this._bruteForceProtection ??= new BruteForceProtection(this._options));
}

public get captcha(): Captcha {
return (this._captcha ??= new Captcha(this._options));
}

public get suspiciousIpThrottling(): SuspiciousIpThrottling {
return (this._suspiciousIpThrottling ??= new SuspiciousIpThrottling(this._options));
}
Expand Down
Loading
Loading