lockout_settings

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

Overview

Name	lockout_settings
Type	Resource
Id	okta.attack_protection.lockout_settings

Fields

The following fields are returned by SELECT queries:

get_user_lockout_settings

Name	Datatype	Description
preventBruteForceLockoutFromUnknownDevices	boolean	Prevents brute-force lockout from unknown devices for the password authenticator.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_lockout_settings	select	subdomain		Retrieves the User Lockout Settings for an org
replace_user_lockout_settings	replace	subdomain		Replaces the User Lockout Settings for an 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	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

SELECT examples

get_user_lockout_settings

Retrieves the User Lockout Settings for an org

SELECT
preventBruteForceLockoutFromUnknownDevices
FROM okta.attack_protection.lockout_settings
WHERE subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

replace_user_lockout_settings

Replaces the User Lockout Settings for an org

REPLACE okta.attack_protection.lockout_settings
SET 
data__preventBruteForceLockoutFromUnknownDevices = {{ preventBruteForceLockoutFromUnknownDevices }}
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
preventBruteForceLockoutFromUnknownDevices
;