authenticator_methods

Creates, updates, deletes, gets or lists an authenticator_methods resource.

Overview

Name	authenticator_methods
Type	Resource
Id	okta.authenticators.authenticator_methods

Fields

The following fields are returned by SELECT queries:

get_authenticator_method

Name	Datatype	Description
_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.
status	string	The status of the authenticator method (ACTIVE, INACTIVE)
type	string	The type of authenticator method (cert, duo, email, idp, otp, password, push, security_question, signed_nonce, sms, totp, voice, webauthn, tac)

list_authenticator_methods

Name	Datatype	Description
_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.
status	string	The status of the authenticator method (ACTIVE, INACTIVE)
type	string	The type of authenticator method (cert, duo, email, idp, otp, password, push, security_question, signed_nonce, sms, totp, voice, webauthn, tac)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_authenticator_method	select	authenticatorId, methodType, subdomain		Retrieves a method identified by methodType of an authenticator identified by authenticatorId
list_authenticator_methods	select	authenticatorId, subdomain		Lists all methods of an authenticator identified by authenticatorId
replace_authenticator_method	replace	authenticatorId, methodType, subdomain		Replaces a method of methodType for an authenticator identified by authenticatorId
activate_authenticator_method	exec	authenticatorId, methodType, subdomain		Activates a method for an authenticator identified by authenticatorId and methodType
deactivate_authenticator_method	exec	authenticatorId, methodType, subdomain		Deactivates a method for an authenticator identified by authenticatorId and methodType
verify_rp_id_domain	exec	authenticatorId, webAuthnMethodType, subdomain		Verifies the Relying Party identifier (RP ID) domain for the specified Passkey (FIDO2 WebAuthn) authenticator and the specific webauthn authenticator method

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
authenticatorId	string	id of the authenticator
methodType	string	Type of authenticator method
subdomain	string	(default: my-org)
webAuthnMethodType	string	Type of authenticator method

SELECT examples

get_authenticator_method

Retrieves a method identified by methodType of an authenticator identified by authenticatorId

SELECT
_links,
status,
type
FROM okta.authenticators.authenticator_methods
WHERE authenticatorId = '{{ authenticatorId }}' -- required
AND methodType = '{{ methodType }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_authenticator_methods

Lists all methods of an authenticator identified by authenticatorId

SELECT
_links,
status,
type
FROM okta.authenticators.authenticator_methods
WHERE authenticatorId = '{{ authenticatorId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

replace_authenticator_method

Replaces a method of methodType for an authenticator identified by authenticatorId

REPLACE okta.authenticators.authenticator_methods
SET 
status = '{{ status }}',
type = '{{ type }}'
WHERE 
authenticatorId = '{{ authenticatorId }}' --required
AND methodType = '{{ methodType }}' --required
AND subdomain = '{{ subdomain }}' --required
RETURNING
_links,
status,
type;

Lifecycle Methods

activate_authenticator_method

Activates a method for an authenticator identified by authenticatorId and methodType

EXEC okta.authenticators.authenticator_methods.activate_authenticator_method 
@authenticatorId='{{ authenticatorId }}' --required, 
@methodType='{{ methodType }}' --required, 
@subdomain='{{ subdomain }}' --required
;

deactivate_authenticator_method

Deactivates a method for an authenticator identified by authenticatorId and methodType

EXEC okta.authenticators.authenticator_methods.deactivate_authenticator_method 
@authenticatorId='{{ authenticatorId }}' --required, 
@methodType='{{ methodType }}' --required, 
@subdomain='{{ subdomain }}' --required
;

verify_rp_id_domain

Verifies the Relying Party identifier (RP ID) domain for the specified Passkey (FIDO2 WebAuthn) authenticator and the specific webauthn authenticator method

EXEC okta.authenticators.authenticator_methods.verify_rp_id_domain 
@authenticatorId='{{ authenticatorId }}' --required, 
@webAuthnMethodType='{{ webAuthnMethodType }}' --required, 
@subdomain='{{ subdomain }}' --required
;