captcha_instances

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

Overview

Name	captcha_instances
Type	Resource
Id	okta.captchas.captcha_instances

Fields

The following fields are returned by SELECT queries:

list_captcha_instances

Name	Datatype	Description
id	string	The unique key for the CAPTCHA instance
name	string	The name of the CAPTCHA instance
_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.
secretKey	string	The secret key issued from the CAPTCHA provider to perform server-side validation for a CAPTCHA token
siteKey	string	The site key issued from the CAPTCHA provider to render a CAPTCHA on a page
type	string	The type of CAPTCHA provider

get_captcha_instance

Name	Datatype	Description
id	string	The unique key for the CAPTCHA instance
name	string	The name of the CAPTCHA instance
_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.
secretKey	string	The secret key issued from the CAPTCHA provider to perform server-side validation for a CAPTCHA token
siteKey	string	The site key issued from the CAPTCHA provider to render a CAPTCHA on a page
type	string	The type of CAPTCHA provider

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_captcha_instances	select	subdomain		Lists all CAPTCHA instances with pagination support. A subset of CAPTCHA instances can be returned that match a supported filter expression or query.
get_captcha_instance	select	subdomain		Retrieves the properties of a specified CAPTCHA instance
create_captcha_instance	insert	subdomain		Creates a new CAPTCHA instance. Currently, an org can only configure a single CAPTCHA instance.
update_captcha_instance	update	subdomain		Partially updates the properties of a specified CAPTCHA instance
replace_captcha_instance	replace	subdomain		Replaces the properties for a specified CAPTCHA instance
delete_captcha_instance	delete	subdomain		Deletes a specified CAPTCHA instance > Note: If your CAPTCHA instance is still associated with your org, the request fails. You must first update your Org-wide CAPTCHA settings to remove the CAPTCHA instance.

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

list_captcha_instances

Lists all CAPTCHA instances with pagination support. A subset of CAPTCHA instances can be returned that match a supported filter expression or query.

SELECT
id,
name,
_links,
secretKey,
siteKey,
type
FROM okta.captchas.captcha_instances
WHERE subdomain = '{{ subdomain }}' -- required;

get_captcha_instance

Retrieves the properties of a specified CAPTCHA instance

SELECT
id,
name,
_links,
secretKey,
siteKey,
type
FROM okta.captchas.captcha_instances
WHERE subdomain = '{{ subdomain }}' -- required;

INSERT examples

create_captcha_instance

Creates a new CAPTCHA instance. Currently, an org can only configure a single CAPTCHA instance.

INSERT INTO okta.captchas.captcha_instances (
data__name,
data__secretKey,
data__siteKey,
data__type,
subdomain
)
SELECT 
'{{ name }}',
'{{ secretKey }}',
'{{ siteKey }}',
'{{ type }}',
'{{ subdomain }}'
RETURNING
id,
name,
_links,
secretKey,
siteKey,
type
;

Manifest

# Description fields are for documentation purposes
- name: captcha_instances
  props:
    - name: subdomain
      value: string
      description: Required parameter for the captcha_instances resource.
    - name: name
      value: string
      description: >
        The name of the CAPTCHA instance
        
    - name: secretKey
      value: string
      description: >
        The secret key issued from the CAPTCHA provider to perform server-side validation for a CAPTCHA token
        
    - name: siteKey
      value: string
      description: >
        The site key issued from the CAPTCHA provider to render a CAPTCHA on a page
        
    - name: type
      value: string
      description: >
        The type of CAPTCHA provider
        
      valid_values: ['HCAPTCHA', 'RECAPTCHA_V2']

UPDATE examples

update_captcha_instance

Partially updates the properties of a specified CAPTCHA instance

UPDATE okta.captchas.captcha_instances
SET 
data__name = '{{ name }}',
data__secretKey = '{{ secretKey }}',
data__siteKey = '{{ siteKey }}',
data__type = '{{ type }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
name,
_links,
secretKey,
siteKey,
type;

REPLACE examples

replace_captcha_instance

Replaces the properties for a specified CAPTCHA instance

REPLACE okta.captchas.captcha_instances
SET 
data__name = '{{ name }}',
data__secretKey = '{{ secretKey }}',
data__siteKey = '{{ siteKey }}',
data__type = '{{ type }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
name,
_links,
secretKey,
siteKey,
type;

DELETE examples

delete_captcha_instance

Deletes a specified CAPTCHA instance
> Note: If your CAPTCHA instance is still associated with your org, the request fails. You must first update your Org-wide CAPTCHA settings to remove the CAPTCHA instance.

DELETE FROM okta.captchas.captcha_instances
WHERE subdomain = '{{ subdomain }}' --required;