Update Suspicious IP Throttling settings

Update the details of the Suspicious IP Throttling configuration of your tenant.

PATCH https://{tenantDomain}/api/v2/attack-protection/suspicious-ip-throttling

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.AttackProtection;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.AttackProtection.SuspiciousIpThrottling.UpdateAsync(
            new UpdateSuspiciousIpThrottlingSettingsRequestContent()
        );
    }

}

package example

import (
    context "context"

    attackprotection "github.com/auth0/go-auth0/v2/management/attackprotection"
    client "github.com/auth0/go-auth0/v2/management/client"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &attackprotection.UpdateSuspiciousIpThrottlingSettingsRequestContent{}
    mgmt.AttackProtection.SuspiciousIpThrottling.Update(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.attackprotection.types.UpdateSuspiciousIpThrottlingSettingsRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.attackProtection().suspiciousIpThrottling().update(
            UpdateSuspiciousIpThrottlingSettingsRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\AttackProtection\SuspiciousIpThrottling\Requests\UpdateSuspiciousIpThrottlingSettingsRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->attackProtection->suspiciousIpThrottling->update(
    new UpdateSuspiciousIpThrottlingSettingsRequestContent([]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.attack_protection.suspicious_ip_throttling.update()

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.attack_protection.suspicious_ip_throttling.update

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.attackProtection.suspiciousIpThrottling.update({});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.attackProtection.suspiciousIpThrottling.update({});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/attack-protection/suspicious-ip-throttling \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "shields": [],
  "allowlist": [
    "127.0.0.1"
  ],
  "stage": {
    "pre-login": {
      "max_attempts": 100,
      "rate": 864000
    },
    "pre-user-registration": {
      "max_attempts": 50,
      "rate": 1728000
    }
  }
}
'

200

{
  "enabled": true,
  "shields": [],
  "allowlist": [
    "127.0.0.1"
  ],
  "stage": {
    "pre-login": {
      "max_attempts": 100,
      "rate": 864000
    },
    "pre-user-registration": {
      "max_attempts": 50,
      "rate": 1728000
    }
  }
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/jsonapplication/x-www-form-urlencoded

enabled · boolean

Whether or not suspicious IP throttling attack protections are active.

shields · enum<string>[]

Action to take when a suspicious IP throttling threshold is violated. Possible values: block, admin_notification.

Available options: block, admin_notification

allowlist · (string<ipv4> | string<cidr> | string<ipv6> | string<ipv6_cidr>)[]

List of trusted IP addresses that will not have attack protection enforced against them.

stage · object

Holds per-stage configuration options (max_attempts and rate).

Show child attributes

Response

200

application/json

Suspicious IP throttling configuration successfully updated.

enabled · boolean

Whether or not suspicious IP throttling attack protections are active.

shields · enum<string>[]

Action to take when a suspicious IP throttling threshold is violated. Possible values: block, admin_notification.

Available options: block, admin_notification

allowlist · (string<ipv4> | string<cidr> | string<ipv6> | string<ipv6_cidr>)[]

List of trusted IP addresses that will not have attack protection enforced against them.

stage · object

Holds per-stage configuration options (max_attempts and rate).

Show child attributes