authenticator_settings
Creates, updates, deletes, gets or lists an authenticator_settings
resource.
Overview
Name | authenticator_settings |
Type | Resource |
Id | okta.attack_protection.authenticator_settings |
Fields
The following fields are returned by SELECT
queries:
- get_authenticator_settings
Name | Datatype | Description |
---|---|---|
verifyKnowledgeSecondWhen2faRequired | boolean | If true, requires users to verify a possession factor before verifying a knowledge factor when the assurance requires two-factor authentication (2FA). |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_authenticator_settings | select | subdomain | Retrieves the Authenticator Settings for an org | |
replace_authenticator_settings | replace | subdomain | Replaces the Authenticator 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_authenticator_settings
Retrieves the Authenticator Settings for an org
SELECT
verifyKnowledgeSecondWhen2faRequired
FROM okta.attack_protection.authenticator_settings
WHERE subdomain = '{{ subdomain }}' -- required;
REPLACE
examples
- replace_authenticator_settings
Replaces the Authenticator Settings for an org
REPLACE okta.attack_protection.authenticator_settings
SET
data__verifyKnowledgeSecondWhen2faRequired = {{ verifyKnowledgeSecondWhen2faRequired }}
WHERE
subdomain = '{{ subdomain }}' --required
RETURNING
verifyKnowledgeSecondWhen2faRequired;