captcha_settings

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

Overview

Name	captcha_settings
Type	Resource
Id	okta.org.captcha_settings

Fields

The following fields are returned by SELECT queries:

get_org_captcha_settings

Name	Datatype	Description
_links	object	Link relations for the CAPTCHA settings object
captchaId	string	The unique key of the associated CAPTCHA instance
enabledPages	array	An array of pages that have CAPTCHA enabled

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_org_captcha_settings	select	subdomain		Retrieves the CAPTCHA settings object for your organization > Note: If the current organization hasn't configured CAPTCHA Settings, the request returns an empty object.
replaces_org_captcha_settings	replace	subdomain		Replaces the CAPTCHA settings object for your organization > Note: You can disable CAPTCHA for your organization by setting captchaId and enabledPages to null.
delete_org_captcha_settings	delete	subdomain		Deletes the CAPTCHA settings object for your organization

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_org_captcha_settings

Retrieves the CAPTCHA settings object for your organization
> Note: If the current organization hasn't configured CAPTCHA Settings, the request returns an empty object.

SELECT
_links,
captchaId,
enabledPages
FROM okta.org.captcha_settings
WHERE subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

replaces_org_captcha_settings

Replaces the CAPTCHA settings object for your organization
> Note: You can disable CAPTCHA for your organization by setting captchaId and enabledPages to null.

REPLACE okta.org.captcha_settings
SET 
data__captchaId = '{{ captchaId }}',
data__enabledPages = '{{ enabledPages }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
_links,
captchaId,
enabledPages
;

DELETE examples

delete_org_captcha_settings

Deletes the CAPTCHA settings object for your organization

DELETE FROM okta.org.captcha_settings
WHERE subdomain = '{{ subdomain }}' --required
;