object CredentialTypes


The credential types that can be transferred as part of the FIDO Credential Exchange Format (CXF) protocol. More about these types can found here. The constants defined in this file list the frequently used credential types in CXF, and are not intended to be the exhaustive list.

Summary

Constants

const String

An address credential provides information for autofilling address forms.

const String

A APIKey credential contains information to interact with an Application’s Programming Interface (API).

const String

A username/password login credential

const String

A CreditCard credential contains information about a credit or debit card.

const String

This credential allows the user to add additional information to the item organized as a grouping that MAY have a label.

const String

A DriversLicense credential contains information about a person’s driver’s license.

const String

A file credential acts as a placeholder to an arbitrary binary file holding its associated metadata.

const String

A GeneratedPassword credential type represents a credential consisting of a machine-generated password.

const String

An IdentityDocument credential is for any document, card, or number identifying a person or entity.

const String

An ItemReference credential is a pointer to another Item, denoting that the two items MAY be logically linked together.

const String

A note credential is a user-defined value encoded as a UTF-8 string

const String

A Passport credential contains the details of a person’s passport.

const String

A PersonName credential represents a person’s name.

const String

A public key credential

const String

An SSHKey credential represents an SSH (Secure Shell) key pair.

const String

A TOTP is a time-based one-time password

const String

A wifi credential provides the necessary information to connect to a Wi-Fi network.

Constants

ADDRESS

Added in 1.0.0-alpha02
const val ADDRESSString

An address credential provides information for autofilling address forms.

API_KEY

Added in 1.0.0-alpha02
const val API_KEYString

A APIKey credential contains information to interact with an Application’s Programming Interface (API).

BASIC_AUTH

Added in 1.0.0-alpha02
const val BASIC_AUTHString

A username/password login credential

CREDIT_CARD

Added in 1.0.0-alpha02
const val CREDIT_CARDString

A CreditCard credential contains information about a credit or debit card.

CUSTOM_FIELDS

Added in 1.0.0-alpha02
const val CUSTOM_FIELDSString

This credential allows the user to add additional information to the item organized as a grouping that MAY have a label. If the exporting provider allows custom fields to be added to items but does not have a grouping concept, it SHOULD use this object without setting the label or id fields.

DRIVERS_LICENSE

Added in 1.0.0-alpha02
const val DRIVERS_LICENSEString

A DriversLicense credential contains information about a person’s driver’s license.

FILE

Added in 1.0.0-alpha02
const val FILEString

A file credential acts as a placeholder to an arbitrary binary file holding its associated metadata.

GENERATED_PASSWORD

Added in 1.0.0-alpha02
const val GENERATED_PASSWORDString

A GeneratedPassword credential type represents a credential consisting of a machine-generated password.

IDENTITY_DOCUMENT

Added in 1.0.0-alpha02
const val IDENTITY_DOCUMENTString

An IdentityDocument credential is for any document, card, or number identifying a person or entity. Examples include national ID cards, Social Security Numbers (SSN), Tax Identification Numbers (TIN), health insurance cards, or Value-Added Tax (VAT) numbers.

ITEM_REFERENCE

Added in 1.0.0-alpha02
const val ITEM_REFERENCEString

An ItemReference credential is a pointer to another Item, denoting that the two items MAY be logically linked together.

NOTE

Added in 1.0.0-alpha02
const val NOTEString

A note credential is a user-defined value encoded as a UTF-8 string

PASSPORT

Added in 1.0.0-alpha02
const val PASSPORTString

A Passport credential contains the details of a person’s passport.

PERSON_NAME

Added in 1.0.0-alpha02
const val PERSON_NAMEString

A PersonName credential represents a person’s name.

PUBLIC_KEY

Added in 1.0.0-alpha02
const val PUBLIC_KEYString

A public key credential

SSH_KEY

Added in 1.0.0-alpha02
const val SSH_KEYString

An SSHKey credential represents an SSH (Secure Shell) key pair.

TOTP

Added in 1.0.0-alpha02
const val TOTPString

A TOTP is a time-based one-time password

WIFI

Added in 1.0.0-alpha02
const val WIFIString

A wifi credential provides the necessary information to connect to a Wi-Fi network.