bot_protection_configuration

Creates, updates, deletes, gets or lists a bot_protection_configuration resource.

Overview

Name	bot_protection_configuration
Type	Resource
Id	okta.bot_protection.bot_protection_configuration

Fields

The following fields are returned by SELECT queries:

get_bot_protection_configuration

Name	Datatype	Description
_links	object	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.
enforcementType	string	The type of enforcement to trigger when a bot is detected (OKTA_CHALLENGE)
level	string	The sensitivity level of bot detection (ANY, HIGH, LOW, MEDIUM)
mode	string	The enforcement mode for bot protection (DISABLED, ENFORCED, LOG_ONLY)
supportedFlows	array	An array of authentication flows that have bot protection enabled

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bot_protection_configuration	select	subdomain		Retrieves the bot protection configuration for your org
update_bot_protection_configuration	update	subdomain, level, mode		Updates the bot protection configuration for your org

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	(default: my-org)

SELECT examples

get_bot_protection_configuration

Retrieves the bot protection configuration for your org

SELECT
_links,
enforcementType,
level,
mode,
supportedFlows
FROM okta.bot_protection.bot_protection_configuration
WHERE subdomain = '{{ subdomain }}' -- required
;

UPDATE examples

update_bot_protection_configuration

Updates the bot protection configuration for your org

UPDATE okta.bot_protection.bot_protection_configuration
SET 
enforcementType = '{{ enforcementType }}',
level = '{{ level }}',
mode = '{{ mode }}',
supportedFlows = '{{ supportedFlows }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND level = '{{ level }}' --required
AND mode = '{{ mode }}' --required
RETURNING
_links,
enforcementType,
level,
mode,
supportedFlows;