How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Auth0 attack-protection API

The attack-protection API from Auth0 — 5 operation(s) for attack-protection.

Auth0 attack-protection API is one of 76 APIs that Auth0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include attack-protection. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 10 operations across 5 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{tenantDomain}/api/v2.

10 operations 5 paths 56 schemas 5 GET5 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://your-tenant.auth0.com/api/v2
Authentication
HTTP Bearer, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Auth0 attack-protection API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (jwt) (bearerAuth). It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 221 scopes. By default, every request must be authenticated.

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 5 GET, 5 PATCH. Each is listed below with its method, path, parameters, and response codes.

attack-protection 10
GET
/attack-protection/bot-detection
Get Bot Detection Settings
get_bot-detection → 200401403404429
PATCH
/attack-protection/bot-detection
Update Bot Detection Settings
patch_bot-detection body → 200400401403404429
GET
/attack-protection/breached-password-detection
Get Breached Password Detection Settings
get_breached-password-detection → 200401403429
PATCH
/attack-protection/breached-password-detection
Update Breached Password Detection Settings
patch_breached-password-detection body → 200400401403429
GET
/attack-protection/brute-force-protection
Get Brute-force Settings
get_brute-force-protection → 200401403429
PATCH
/attack-protection/brute-force-protection
Update Brute-force Settings
patch_brute-force-protection body → 200400401403429
GET
/attack-protection/captcha
Get the CAPTCHA Configuration for a Tenant
get_captcha → 200401403404429
PATCH
/attack-protection/captcha
Partial Update for CAPTCHA Configuration
patch_captcha body → 200401403404429
GET
/attack-protection/suspicious-ip-throttling
Get Suspicious IP Throttling Settings
get_suspicious-ip-throttling → 200401403429
PATCH
/attack-protection/suspicious-ip-throttling
Update Suspicious IP Throttling Settings
patch_suspicious-ip-throttling body → 200400401403429

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are UpdateAttackProtectionCaptchaRequestContent (8 properties), GetAttackProtectionCaptchaResponseContent (8 properties), UpdateAttackProtectionCaptchaResponseContent (8 properties), GetBotDetectionSettingsResponseContent (6 properties). Each schema is shown below with its type and property counts.

SuspiciousIPThrottlingAllowlist
array
List of trusted IP addresses that will not have attack protection enforced against them.
BreachedPasswordDetectionPreUserRegistrationShieldsEnum
string
AttackProtectionUpdateCaptchaFriendlyCaptcha
object
2 properties 2 required
AttackProtectionCaptchaRecaptchaEnterpriseResponseContent
object
2 properties
BruteForceProtectionModeEnum
string
Account Lockout: Determines whether or not IP address is used when counting failed attempts. Possible values: countperidentifierandip , countperidentifier .
BreachedPasswordDetectionPreUserRegistrationStage
object
1 property
BreachedPasswordDetectionPreChangePasswordShieldsEnum
string
UpdateBotDetectionSettingsRequestContent
object
6 properties
UpdateAttackProtectionCaptchaRequestContent
object
8 properties
BreachedPasswordDetectionAdminNotificationFrequencyEnum
string
SuspiciousIPThrottlingPreLoginStage
object
Configuration options that apply before every login attempt.
2 properties
BruteForceProtectionShieldsEnum
string
AttackProtectionUpdateCaptchaArkose
object
5 properties 2 required
UpdateBotDetectionSettingsResponseContent
object
6 properties
BotDetectionCidrBlock
string
CIDR block
AttackProtectionCaptchaAuthChallengeRequest
object
1 property 1 required
BreachedPasswordDetectionPreChangePasswordStage
object
1 property
UpdateAttackProtectionCaptchaResponseContent
object
8 properties
GetBreachedPasswordDetectionSettingsResponseContent
object
5 properties
SuspiciousIPThrottlingShieldsEnum
string
BotDetectionChallengePolicyPasswordlessFlowEnum
string
The policy that defines how often to show CAPTCHA
BotDetectionChallengePolicyPasswordFlowEnum
string
The policy that defines how often to show CAPTCHA
AttackProtectionCaptchaAuthChallengeResponseContent
object
1 property
BotDetectionAllowlist
array
List of IP addresses or CIDR blocks to allowlist
AttackProtectionCaptchaArkoseResponseContent
object
4 properties
AttackProtectionUpdateCaptchaRecaptchaV2
object
2 properties 2 required
BotDetectionIPAddressOrCidrBlock
string
IP address (IPv4 or IPv6) or CIDR block
BotDetectionIPv6
string
IPv6 address
BreachedPasswordDetectionShieldsEnum
string
UpdateBruteForceSettingsResponseContent
object
5 properties
AttackProtectionCaptchaFriendlyCaptchaResponseContent
object
1 property
AttackProtectionCaptchaSimpleCaptchaResponseContent
object
GetBruteForceSettingsResponseContent
object
5 properties
SuspiciousIPThrottlingAllowlistItem
string
AttackProtectionUpdateCaptchaHcaptcha
object
2 properties 2 required
BotDetectionChallengePolicyPasswordResetFlowEnum
string
The policy that defines how often to show CAPTCHA
BotDetectionIPv4
string
IPv4 address
GetBotDetectionSettingsResponseContent
object
6 properties 6 required
AttackProtectionCaptchaRecaptchaV2ResponseContent
object
1 property
UpdateSuspiciousIPThrottlingSettingsResponseContent
object
4 properties
GetSuspiciousIPThrottlingSettingsResponseContent
object
4 properties
UpdateBreachedPasswordDetectionSettingsRequestContent
object
5 properties
GetAttackProtectionCaptchaResponseContent
object
8 properties
UpdateBruteForceSettingsRequestContent
object
5 properties
AttackProtectionCaptchaProviderId
string
The id of the active provider for the CAPTCHA.
BotDetectionLevelEnum
string
The level of bot detection sensitivity
AttackProtectionCaptchaHcaptchaResponseContent
object
1 property
UpdateBreachedPasswordDetectionSettingsResponseContent
object
5 properties
SuspiciousIPThrottlingStage
object
Holds per-stage configuration options (maxattempts and rate).
2 properties
SuspiciousIPThrottlingPreUserRegistrationStage
object
Configuration options that apply before every user registration attempt.
2 properties
BotDetectionIPv6CidrBlock
string
IPv6 CIDR block
AttackProtectionUpdateCaptchaRecaptchaEnterprise
object
3 properties 3 required
BreachedPasswordDetectionMethodEnum
string
The subscription level for breached password detection methods. Use "enhanced" to enable Credential Guard. Possible values: standard , enhanced .
BreachedPasswordDetectionStage
object
2 properties
BotDetectionMonitoringModeEnabled
boolean
Whether monitoring mode is enabled (logs but does not block)
UpdateSuspiciousIPThrottlingSettingsRequestContent
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

auth0-attack-protection-api-openapi.yml Raw ↑

Other APIs Auth0 publishes across the network.

Auth0 My Account API
Auth0 My Organization API
Auth0 for AI Agents
Auth0 actions API
Auth0 anomaly API
Auth0 Assertions API
Auth0 Authorization Models API
Auth0 Authorize User API
Auth0 AuthZenService API
Auth0 branding API
Auth0 client-grants API
Auth0 clients API
Where this information came from

This is an independent, third-party profile of Auth0 attack-protection API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.