The authenticator attestation identifier: a unique identifier assigned to a model, class or batch of FIDO Authenticators that all share the same characteristics, and which a Relying Party can use to look up an Attestation Public Key and Authenticator Metadata for the device.

The AAID is a string with format "V#M", where:

  • "#" is a separator.
  • "V" indicates the authenticator Vendor Code. This code consists of 4 hexadecimal digits.
  • "M" indicates the authenticator Model Code. This code consists of 4 hexadecimal digits.

Hierarchy

  • Aaid

Properties

name: string

The name of the Aaid.

ordinal: number

The ordinal of the Aaid.

Accessors

  • get PIN(): Aaid
  • Represents the PIN authenticator.

    Returns Aaid

  • get FINGERPRINT(): Aaid
  • Represents the fingerprint authenticator.

    Returns Aaid

    Remarks

    • Android: this represents the legacy Fingerprint authenticator.
    • iOS: not supported.
  • get BIOMETRIC(): Aaid
  • Represents the biometric authenticator.

    Returns Aaid

    Remarks

    • Android: represents the Biometric authenticator.
    • iOS: represents both the Touch ID and the Face ID authenticator, as only one of them exists in a device.
  • get DEVICE_PASSCODE(): Aaid
  • Represents the device passcode authenticator.

    Returns Aaid

  • get PASSWORD(): Aaid
  • Represents the password authenticator.

    Returns Aaid

Methods

  • The function that returns the Authenticator Attestation ID for an authenticator taking into consideration the current platform.

    Returns string

    Example

    let pinAuthenticatorAaid = Aaid.PIN.rawValue()

    // Returns F1D0#0001 on Android
    // Returns F1D0#1001 on iOS

Generated using TypeDoc