- Retrieve the bot protection configuration
- okta.botProtection.read
Retrieves the bot protection configuration for your org
- https://subdomain.okta.comhttps://subdomain.okta.com/api/v1/bot-protection/configuration
curl -i -X GET \
https://subdomain.okta.com/api/v1/bot-protection/configurationOK
The type of enforcement to trigger when a bot is detected
| Value | Description |
|---|---|
| OKTA_CHALLENGE | The Okta built-in challenge mechanism |
The sensitivity level of bot detection
| Enum Value | Description |
|---|---|
| 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. |
The enforcement mode for bot protection
| Enum Value | Description |
|---|---|
| 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 |
Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
{ "level": "LOW", "mode": "LOG_ONLY", "supportedFlows": [ "SIGN_IN", "SSR", "SSPR" ], "_links": { "self": { … } } }