custom_aaguids

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

Overview

Name	custom_aaguids
Type	Resource
Id	okta.authenticators.custom_aaguids

Fields

The following fields are returned by SELECT queries:

list_all_custom_aaguids

Name	Datatype	Description
name	string	The product name associated with the AAGUID
_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.
aaguid	string	A unique 128-bit identifier that's assigned to a specific model of security key or authenticator
attestationRootCertificates	array
authenticatorCharacteristics	object	Contains additional properties about custom AAGUID.

get_custom_aaguid

Name	Datatype	Description
name	string	The product name associated with the AAGUID
_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.
aaguid	string	A unique 128-bit identifier that's assigned to a specific model of security key or authenticator
attestationRootCertificates	array
authenticatorCharacteristics	object	Contains additional properties about custom AAGUID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_all_custom_aaguids	select	subdomain		Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org Only custom AAGUIDs that an admin has created are returned.
get_custom_aaguid	select	subdomain		Retrieves a custom AAGUID
create_custom_aaguid	insert	subdomain		Creates a custom AAGUID for the WebAuthn authenticator
update_custom_aaguid	update	subdomain		Updates the properties of a custom AAGUID by the authenticatorId and aaguid ID
replace_custom_aaguid	replace	subdomain		Replaces a custom AAGUID for the specified WebAuthn authenticator
delete_custom_aaguid	delete	subdomain		Deletes a custom AAGUID You can only delete custom AAGUIDs that an admin has created.

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_all_custom_aaguids

Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org

Only custom AAGUIDs that an admin has created are returned.

SELECT
name,
_links,
aaguid,
attestationRootCertificates,
authenticatorCharacteristics
FROM okta.authenticators.custom_aaguids
WHERE subdomain = '{{ subdomain }}' -- required
;

get_custom_aaguid

Retrieves a custom AAGUID

SELECT
name,
_links,
aaguid,
attestationRootCertificates,
authenticatorCharacteristics
FROM okta.authenticators.custom_aaguids
WHERE subdomain = '{{ subdomain }}' -- required
;

INSERT examples

create_custom_aaguid

Creates a custom AAGUID for the WebAuthn authenticator

INSERT INTO okta.authenticators.custom_aaguids (
data__aaguid,
data__attestationRootCertificates,
data__authenticatorCharacteristics,
subdomain
)
SELECT 
'{{ aaguid }}',
'{{ attestationRootCertificates }}',
'{{ authenticatorCharacteristics }}',
'{{ subdomain }}'
RETURNING
name,
_links,
aaguid,
attestationRootCertificates,
authenticatorCharacteristics
;

Manifest

# Description fields are for documentation purposes
- name: custom_aaguids
  props:
    - name: subdomain
      value: string
      description: Required parameter for the custom_aaguids resource.
    - name: aaguid
      value: string
      description: >
        An Authenticator Attestation Global Unique Identifier (AAGUID) is a 128-bit identifier indicating the model.
        
    - name: attestationRootCertificates
      value: array
      description: >
        Contains the certificate and information about it
        
    - name: authenticatorCharacteristics
      value: object
      description: >
        Contains additional properties about custom AAGUID.
        

UPDATE examples

update_custom_aaguid

Updates the properties of a custom AAGUID by the authenticatorId and aaguid ID

UPDATE okta.authenticators.custom_aaguids
SET 
data__attestationRootCertificates = '{{ attestationRootCertificates }}',
data__authenticatorCharacteristics = '{{ authenticatorCharacteristics }}',
data__name = '{{ name }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
name,
_links,
aaguid,
attestationRootCertificates,
authenticatorCharacteristics
;

REPLACE examples

replace_custom_aaguid

Replaces a custom AAGUID for the specified WebAuthn authenticator

REPLACE okta.authenticators.custom_aaguids
SET 
data__attestationRootCertificates = '{{ attestationRootCertificates }}',
data__authenticatorCharacteristics = '{{ authenticatorCharacteristics }}',
data__name = '{{ name }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
name,
_links,
aaguid,
attestationRootCertificates,
authenticatorCharacteristics
;

DELETE examples

delete_custom_aaguid

Deletes a custom AAGUID

You can only delete custom AAGUIDs that an admin has created.

DELETE FROM okta.authenticators.custom_aaguids
WHERE subdomain = '{{ subdomain }}' --required
;