yubikey_otp_tokens

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

Overview

Name	yubikey_otp_tokens
Type	Resource
Id	okta.org.yubikey_otp_tokens

Fields

The following fields are returned by SELECT queries:

list_yubikey_otp_tokens

Name	Datatype	Description
id	string	ID of the token (example: ykkwcx13nrDq8g4oy0g3)
_embedded	object
_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.
created	string (date-time)	Timestamp when the token was created (example: 2022-08-25T00:31:00.000Z)
lastUpdated	string (date-time)	Timestamp when the token was last updated (example: 2022-08-25T00:31:00.000Z)
lastVerified	string (date-time)	Timestamp when the token was last verified (example: 2022-08-25T00:31:00.000Z)
profile	object	Specified profile information for token
status	string	Token status

get_yubikey_otp_token_by_id

Name	Datatype	Description
id	string	ID of the token (example: ykkwcx13nrDq8g4oy0g3)
_embedded	object
_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.
created	string (date-time)	Timestamp when the token was created (example: 2022-08-25T00:31:00.000Z)
lastUpdated	string (date-time)	Timestamp when the token was last updated (example: 2022-08-25T00:31:00.000Z)
lastVerified	string (date-time)	Timestamp when the token was last verified (example: 2022-08-25T00:31:00.000Z)
profile	object	Specified profile information for token
status	string	Token status

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_yubikey_otp_tokens	select	subdomain		Lists all YubiKey OTP tokens
get_yubikey_otp_token_by_id	select	tokenId, subdomain		Retrieves the specified YubiKey OTP token by id
upload_yubikey_otp_token_seed	exec	subdomain		Uploads a seed for a user to enroll a YubiKey OTP

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)
tokenId	string	The YubiKey OTP token ID

SELECT examples

list_yubikey_otp_tokens

Lists all YubiKey OTP tokens

SELECT
id,
_embedded,
_links,
created,
lastUpdated,
lastVerified,
profile,
status
FROM okta.org.yubikey_otp_tokens
WHERE subdomain = '{{ subdomain }}' -- required;

get_yubikey_otp_token_by_id

Retrieves the specified YubiKey OTP token by id

SELECT
id,
_embedded,
_links,
created,
lastUpdated,
lastVerified,
profile,
status
FROM okta.org.yubikey_otp_tokens
WHERE tokenId = '{{ tokenId }}' -- required
AND subdomain = '{{ subdomain }}' -- required;

Lifecycle Methods

upload_yubikey_otp_token_seed

Uploads a seed for a user to enroll a YubiKey OTP

EXEC okta.org.yubikey_otp_tokens.upload_yubikey_otp_token_seed 
@subdomain='{{ subdomain }}' --required 
@@json=
'{
"serialNumber": "{{ serialNumber }}", 
"publicId": "{{ publicId }}", 
"privateId": "{{ privateId }}", 
"aesKey": "{{ aesKey }}"
}';