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:

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.

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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_aaguid	select	authenticatorId, aaguid, subdomain		Retrieves a custom AAGUID
list_all_custom_aaguids	select	authenticatorId, subdomain		Lists all custom Authenticator Attestation Global Unique Identifiers (AAGUIDs) in the org Only custom AAGUIDs that an admin has created are returned.
create_custom_aaguid	insert	authenticatorId, subdomain		Creates a custom AAGUID for the Passkey (FIDO2 WebAuthn) authenticator
update_custom_aaguid	update	authenticatorId, aaguid, subdomain		Updates the properties of a custom AAGUID by the authenticatorId and aaguid ID
replace_custom_aaguid	replace	authenticatorId, aaguid, subdomain		Replaces a custom AAGUID for the specified Passkey (FIDO2 WebAuthn) authenticator
delete_custom_aaguid	delete	authenticatorId, aaguid, 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
aaguid	string	Unique ID of a custom AAGUID
authenticatorId	string	id of the authenticator
subdomain	string	(default: my-org)

SELECT examples

get_custom_aaguid

Retrieves a custom AAGUID

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

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 authenticatorId = '{{ authenticatorId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

INSERT examples

create_custom_aaguid

Creates a custom AAGUID for the Passkey (FIDO2 WebAuthn) authenticator

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

Manifest

# Description fields are for documentation purposes
- name: custom_aaguids
props:
  - name: authenticatorId
    value: "{{ authenticatorId }}"
    description: Required parameter for the custom_aaguids resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the custom_aaguids resource.
  - name: aaguid
    value: "{{ aaguid }}"
    description: |
      An Authenticator Attestation Global Unique Identifier (AAGUID) is a 128-bit identifier indicating the model.
  - name: attestationRootCertificates
    description: |
      Contains the certificate and information about it
    value:
      - x5c: "{{ x5c }}"
  - name: authenticatorCharacteristics
    description: |
      Contains additional properties about custom AAGUID.
    value:
      fipsCompliant: {{ fipsCompliant }}
      hardwareProtected: {{ hardwareProtected }}
      platformAttached: {{ platformAttached }}

UPDATE examples

update_custom_aaguid

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

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

REPLACE examples

replace_custom_aaguid

Replaces a custom AAGUID for the specified Passkey (FIDO2 WebAuthn) authenticator

REPLACE okta.authenticators.custom_aaguids
SET 
attestationRootCertificates = '{{ attestationRootCertificates }}',
authenticatorCharacteristics = '{{ authenticatorCharacteristics }}',
name = '{{ name }}'
WHERE 
authenticatorId = '{{ authenticatorId }}' --required
AND aaguid = '{{ aaguid }}' --required
AND 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 authenticatorId = '{{ authenticatorId }}' --required
AND aaguid = '{{ aaguid }}' --required
AND subdomain = '{{ subdomain }}' --required
;