PublicKeyCredential

public final class PublicKeyCredential extends Credential

java.lang.Object
   ↳ androidx.credentials.Credential
     ↳ androidx.credentials.PublicKeyCredential

Represents the user's passkey credential granted by the user for app sign-in.

Summary

Constants
static final @NonNull String

The type value for public key credential related operations.

Public constructors
PublicKeyCredential(@NonNull String authenticationResponseJson)

Constructs a PublicKeyCredential.

Public methods
final @NonNull String

the public key credential authentication response in JSON format that follows the standard webauthn json format shown at this w3c link

Inherited methods
From androidx.credentials.Credential
final @NonNull Bundle

the credential data in the Bundle format
final @NonNull String

the credential type determined by the credential-type-specific subclass (e.g. PasswordCredential.TYPE_PASSWORD_CREDENTIAL for PasswordCredential or PublicKeyCredential.TYPE_PUBLIC_KEY_CREDENTIAL for PublicKeyCredential)

Constants

TYPE_PUBLIC_KEY_CREDENTIAL

public static final @NonNull String TYPE_PUBLIC_KEY_CREDENTIAL

The type value for public key credential related operations.

Public constructors

PublicKeyCredential

Added in 1.2.0
public PublicKeyCredential(@NonNull String authenticationResponseJson)

Constructs a PublicKeyCredential.

Parameters
@NonNull String authenticationResponseJson

the public key credential authentication response in JSON format that follows the standard webauthn json format shown at this w3c link
Throws
kotlin.NullPointerException

If authenticationResponseJson is null
kotlin.IllegalArgumentException

If authenticationResponseJson is empty, or if it is not a valid JSON

Public methods

getAuthenticationResponseJson

Added in 1.2.0
public final @NonNull String getAuthenticationResponseJson()

the public key credential authentication response in JSON format that follows the standard webauthn json format shown at this w3c link