Get the environment's bot and abuse protection settings
GET /v1/user_management/bot_protection: Get the environment's bot and abuse protection settings.
GET /
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
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 OK BotProtectionSettings
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
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"const response = await fetch("https://api.ohauthcat.com/v1/user_management/bot_protection", { method: "GET", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.get( "https://api.ohauthcat.com/v1/user_management/bot_protection", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "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 } ]}