CredentialTypes

Artifact: androidx.credentials.providerevents:providerevents

View Source

Added in 1.0.0-alpha02

---

Kotlin |Java

public static class 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
static final @NonNull String	ADDRESS An address credential provides information for autofilling address forms.
static final @NonNull String	API_KEY A APIKey credential contains information to interact with an Application’s Programming Interface (API).
static final @NonNull String	BASIC_AUTH A username/password login credential
static final @NonNull String	CREDIT_CARD A CreditCard credential contains information about a credit or debit card.
static final @NonNull String	CUSTOM_FIELDS This credential allows the user to add additional information to the item organized as a grouping that MAY have a label.
static final @NonNull String	DRIVERS_LICENSE A DriversLicense credential contains information about a person’s driver’s license.
static final @NonNull String	FILE A file credential acts as a placeholder to an arbitrary binary file holding its associated metadata.
static final @NonNull String	GENERATED_PASSWORD A GeneratedPassword credential type represents a credential consisting of a machine-generated password.
static final @NonNull String	IDENTITY_DOCUMENT An IdentityDocument credential is for any document, card, or number identifying a person or entity.
static final @NonNull String	ITEM_REFERENCE An ItemReference credential is a pointer to another Item, denoting that the two items MAY be logically linked together.
static final @NonNull String	NOTE A note credential is a user-defined value encoded as a UTF-8 string
static final @NonNull String	PASSPORT A Passport credential contains the details of a person’s passport.
static final @NonNull String	PERSON_NAME A PersonName credential represents a person’s name.
static final @NonNull String	PUBLIC_KEY A public key credential
static final @NonNull String	SSH_KEY An SSHKey credential represents an SSH (Secure Shell) key pair.
static final @NonNull String	TOTP A TOTP is a time-based one-time password
static final @NonNull String	WIFI A wifi credential provides the necessary information to connect to a Wi-Fi network.

Public fields
static @NonNull CredentialTypes	INSTANCE

Constants

ADDRESS

Added in 1.0.0-alpha02

public static final @NonNull String ADDRESS

An address credential provides information for autofilling address forms.

API_KEY

Added in 1.0.0-alpha02

public static final @NonNull String API_KEY

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

BASIC_AUTH

Added in 1.0.0-alpha02

public static final @NonNull String BASIC_AUTH

A username/password login credential

CREDIT_CARD

Added in 1.0.0-alpha02

public static final @NonNull String CREDIT_CARD

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

CUSTOM_FIELDS

Added in 1.0.0-alpha02

public static final @NonNull String CUSTOM_FIELDS

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

public static final @NonNull String DRIVERS_LICENSE

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

FILE

Added in 1.0.0-alpha02

public static final @NonNull String FILE

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

GENERATED_PASSWORD

Added in 1.0.0-alpha02

public static final @NonNull String GENERATED_PASSWORD

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

IDENTITY_DOCUMENT

Added in 1.0.0-alpha02

public static final @NonNull String IDENTITY_DOCUMENT

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

public static final @NonNull String ITEM_REFERENCE

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

public static final @NonNull String NOTE

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

PASSPORT

Added in 1.0.0-alpha02

public static final @NonNull String PASSPORT

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

PERSON_NAME

Added in 1.0.0-alpha02

public static final @NonNull String PERSON_NAME

A PersonName credential represents a person’s name.

PUBLIC_KEY

Added in 1.0.0-alpha02

public static final @NonNull String PUBLIC_KEY

A public key credential

SSH_KEY

Added in 1.0.0-alpha02

public static final @NonNull String SSH_KEY

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

TOTP

Added in 1.0.0-alpha02

public static final @NonNull String TOTP

A TOTP is a time-based one-time password

WIFI

Added in 1.0.0-alpha02

public static final @NonNull String WIFI

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

Public fields

INSTANCE

Added in 1.0.0-alpha02

public static @NonNull CredentialTypes INSTANCE