Skip to content
Dashboard
Theme
Theme

Get the environment's bot and abuse protection settings

GET /v1/user_management/bot_protection: Get the environment's bot and abuse protection settings.

View Markdown

GET /v1/user_management/bot_protection

CAPTCHA (Cloudflare Turnstile), device signals and the ordered rules applied to end-user sign-in and sign-up on the hosted login pages. The developer’s Turnstile secret is never returned; turnstile_secret_set says whether one is stored.

Scope
users:read
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

Errors share one shape; see the error code catalogue.

curl -X GET \
"https://api.ohauthcat.com/v1/user_management/bot_protection" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY"
Response 200
{
"object": "bot_protection",
"captcha_mode": "off",
"captcha_provider": "managed",
"turnstile_site_key": "plan",
"turnstile_secret_set": true,
"device_tracking": true,
"new_device_email": true,
"rules": [
{
"id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"kind": "country",
"action": "allow",
"challenge": "captcha",
"enabled": true,
"flows": [
"sign_in"
],
"values": [
"enterprise"
],
"not_in": true,
"threshold": 1,
"window_seconds": 60,
"days": 1
}
]
}