mfa_recovery_pin_setting

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

Overview

Name	mfa_recovery_pin_setting
Type	Resource
Id	okta.device_access.mfa_recovery_pin_setting

Fields

The following fields are returned by SELECT queries:

get_desktop_mfarecovery_pin_org_setting

Name	Datatype	Description
desktopMFARecoveryPinEnabled	boolean	Indicates whether or not the Desktop MFA Recovery PIN feature is enabled

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_desktop_mfarecovery_pin_org_setting	select	subdomain		Retrieves the status of the Desktop MFA Recovery PIN feature. That is, whether or not the feature is enabled for your org.
replace_desktop_mfarecovery_pin_org_setting	replace	subdomain		Replaces the Desktop MFA Recovery PIN feature 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	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_desktop_mfarecovery_pin_org_setting

Retrieves the status of the Desktop MFA Recovery PIN feature. That is, whether or not the feature is enabled for your org.

SELECT
desktopMFARecoveryPinEnabled
FROM okta.device_access.mfa_recovery_pin_setting
WHERE subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

replace_desktop_mfarecovery_pin_org_setting

Replaces the Desktop MFA Recovery PIN feature for your org

REPLACE okta.device_access.mfa_recovery_pin_setting
SET 
data__desktopMFARecoveryPinEnabled = {{ desktopMFARecoveryPinEnabled }}
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
desktopMFARecoveryPinEnabled
;