BeginGetPublicKeyCredentialOption

class BeginGetPublicKeyCredentialOption : BeginGetCredentialOption

kotlin.Any
   ↳ androidx.credentials.provider.BeginGetCredentialOption
     ↳ androidx.credentials.provider.BeginGetPublicKeyCredentialOption

A request to begin the flow of getting passkeys from the user's public key credential provider.

Throws
kotlin.NullPointerException

If requestJson is null
kotlin.IllegalArgumentException

If requestJson is empty, or is not a valid JSON

Note : Credential providers are not expected to utilize the constructor in this class for any production flow. This constructor must only be used for testing purposes.

Summary

Public constructors
BeginGetPublicKeyCredentialOption(
    candidateQueryData: Bundle,
    id: String,
    requestJson: String,
    clientDataHash: ByteArray?
)

constructs an instance of BeginGetPublicKeyCredentialOption

Public properties
ByteArray?

a hash that is used to verify the relying party identity, set only if android.service.credentials.CallingAppInfo.getOrigin is set
String

the request in JSON format in the standard webauthn web json shown here

Inherited properties
From androidx.credentials.provider.BeginGetCredentialOption
Bundle

the parameters needed to retrieve the credentials, in the form of the raw Bundle - can typically be ignored by the credential provider as the required properties are already parse into the structured subclasses
String

unique id representing this particular option, to be used while constructing the CredentialEntry to be set on BeginGetCredentialResponse
String

the type of the credential to be retrieved against this option, e.g. a BeginGetPasswordOption will have type PasswordCredential.TYPE_PASSWORD_CREDENTIAL

Public constructors

BeginGetPublicKeyCredentialOption

Added in 1.2.0
BeginGetPublicKeyCredentialOption(
    candidateQueryData: Bundle,
    id: String,
    requestJson: String,
    clientDataHash: ByteArray? = null
)

constructs an instance of BeginGetPublicKeyCredentialOption

Parameters
candidateQueryData: Bundle

the request data in the Bundle format
id: String

the id of this request option
requestJson: String

the request in JSON format in the standard webauthn web json shown here
clientDataHash: ByteArray? = null

a hash that is used to verify the relying party identity, set only if android.service.credentials.CallingAppInfo.getOrigin is set

Public properties

clientDataHash

Added in 1.2.0
val clientDataHash: ByteArray?

a hash that is used to verify the relying party identity, set only if android.service.credentials.CallingAppInfo.getOrigin is set

requestJson

Added in 1.2.0
val requestJson: String

the request in JSON format in the standard webauthn web json shown here