Skip to content

Retrieve the bot protection configuration

Request

OAuth 2.0 scope:
  • okta.botProtection.read

Retrieves the bot protection configuration for your org

curl -i -X GET \
  https://subdomain.okta.com/api/v1/bot-protection/configuration

Responses

OK

Bodyapplication/json
enforcementTypestring(BotProtectionEnforcementType)

The type of enforcement to trigger when a bot is detected

ValueDescription
OKTA_CHALLENGE

The Okta built-in challenge mechanism

levelstring(BotProtectionLevel)required

The sensitivity level of bot detection

Enum ValueDescription
HIGH

High - Flags only high-confidence bot requests. Prioritizes a frictionless user experience.

MEDIUM

Medium and above - Flags moderate and high-confidence bot requests. Provides a balanced experience and security.

LOW

Low and above - Flags low-confidence bot requests. Prioritizes a rigorous security.

ANY

Always flag all requests to trigger enforcement settings, regardless of bot likeliness confidence level.

modestring(BotProtectionMode)required

The enforcement mode for bot protection

Enum ValueDescription
DISABLED

Bot protection is disabled

LOG_ONLY

Bot detection events are logged but not enforced

ENFORCED

Enforcement is applied to events where bots are detected

supportedFlowsArray of strings

An array of authentication flows that have bot protection enabled

Response
{ "level": "LOW", "mode": "LOG_ONLY", "supportedFlows": [ "SIGN_IN", "SSR", "SSPR" ], "_links": { "self": { … } } }