CreatePublicKeyCredentialRequest

Artifact: androidx.credentials:credentials

Added in 1.2.0

Kotlin |Java

public final class CreatePublicKeyCredentialRequest extends CreateCredentialRequest

java.lang.Object
↳	androidx.credentials.CreateCredentialRequest
	↳	androidx.credentials.CreatePublicKeyCredentialRequest

A request to register a passkey from the user's public key credential provider.

Summary

Public constructors
`CreatePublicKeyCredentialRequest( @NonNull String requestJson, byte[] clientDataHash, boolean preferImmediatelyAvailableCredentials, String origin, boolean isAutoSelectAllowed )` Constructs a `CreatePublicKeyCredentialRequest` to register a passkey from the user's public key credential provider.
`CreatePublicKeyCredentialRequest( @NonNull String requestJson, byte[] clientDataHash, boolean preferImmediatelyAvailableCredentials, String origin, String preferDefaultProvider, boolean isAutoSelectAllowed )` Constructs a `CreatePublicKeyCredentialRequest` to register a passkey from the user's public key credential provider.

Public methods
`final byte[]`	`getClientDataHash()` a clientDataHash value to sign over in place of assembling and hashing clientDataJSON during the signature request; only meaningful when `origin` is set
`final @NonNull String`	`getRequestJson()` the request in JSON format in the standard webauthn web json.

Inherited methods

From androidx.credentials.CreateCredentialRequest

`final @NonNull Bundle`	`getCandidateQueryData()` the partial request data in the `Bundle` format that will be sent to the provider during the initial candidate query stage, which should not contain sensitive user credential information (note: bundle keys in the form of `androidx.credentials.*` are reserved for internal library use)
`final @NonNull Bundle`	`getCredentialData()` the request data in the `Bundle` format
`final @NonNull CreateCredentialRequest.DisplayInfo`	`getDisplayInfo()` the information to be displayed on the screen
`final String`	`getOrigin()` the origin of a different application if the request is being made on behalf of that application (Note: for API level >=34, setting a non-null value for this parameter will throw a SecurityException if android.permission.CREDENTIAL_MANAGER_SET_ORIGIN is not present)
`final boolean`	`preferImmediatelyAvailableCredentials()` true if you prefer the operation to return immediately when there is no available passkey registration offering instead of falling back to discovering remote options, and false (preferred by default) otherwise
`final @NonNull String`	`getType()` the credential type determined by the credential-type-specific subclass (e.g. the type for `CreatePasswordRequest` is `PasswordCredential.TYPE_PASSWORD_CREDENTIAL` and for `CreatePublicKeyCredentialRequest` is `PublicKeyCredential.TYPE_PUBLIC_KEY_CREDENTIAL`)
`final boolean`	`isAutoSelectAllowed()` whether a create option will be automatically chosen if it is the only one available to the user
`final boolean`	`isSystemProviderRequired()` true if must only be fulfilled by a system provider and false otherwise

Public constructors

CreatePublicKeyCredentialRequest

Added in 1.2.0

public CreatePublicKeyCredentialRequest(
    @NonNull String requestJson,
    byte[] clientDataHash,
    boolean preferImmediatelyAvailableCredentials,
    String origin,
    boolean isAutoSelectAllowed
)

Constructs a CreatePublicKeyCredentialRequest to register a passkey from the user's public key credential provider.

Parameters
`@NonNull String requestJson`	the privileged request in JSON format in the standard webauthn web json.
`byte[] clientDataHash`	a hash that is used to verify the relying party identity
`boolean preferImmediatelyAvailableCredentials`	true if you prefer the operation to return immediately when there is no available passkey registration offering instead of falling back to discovering remote options, and false (default) otherwise
`String origin`	the origin of a different application if the request is being made on behalf of that application (Note: for API level >=34, setting a non-null value for this parameter will throw a SecurityException if android.permission.CREDENTIAL_MANAGER_SET_ORIGIN is not present)
`boolean isAutoSelectAllowed`	whether a create option will be automatically chosen if it is the only one available to the user (note that there is a chance that the crendeiatl provider does not support auto-select even if you turn this bit on)

Throws
`kotlin.NullPointerException`	If `requestJson` is null
`kotlin.IllegalArgumentException`	If `requestJson` is empty, or if it is not a valid JSON, or if it doesn't have a valid `user.name` defined according to the webauthn spec (https://w3c.github.io/webauthn/#dictdef-publickeycredentialcreationoptionsjson)

CreatePublicKeyCredentialRequest

Added in 1.2.0

public CreatePublicKeyCredentialRequest(
    @NonNull String requestJson,
    byte[] clientDataHash,
    boolean preferImmediatelyAvailableCredentials,
    String origin,
    String preferDefaultProvider,
    boolean isAutoSelectAllowed
)

Constructs a CreatePublicKeyCredentialRequest to register a passkey from the user's public key credential provider.

Parameters
`@NonNull String requestJson`	the privileged request in JSON format in the standard webauthn web json.
`byte[] clientDataHash`	a hash that is used to verify the relying party identity
`boolean preferImmediatelyAvailableCredentials`	true if you prefer the operation to return immediately when there is no available passkey registration offering instead of falling back to discovering remote options, and false (preferably) otherwise
`String origin`	the origin of a different application if the request is being made on behalf of that application (Note: for API level >=34, setting a non-null value for this parameter will throw a SecurityException if android.permission.CREDENTIAL_MANAGER_SET_ORIGIN is not present)
`String preferDefaultProvider`	the preferred default provider component name to prioritize in the selection UI flows (Note: tour app must have the permission android.permission.CREDENTIAL_MANAGER_SET_ALLOWED_PROVIDERS to specify this, or it would not take effect; also this bit may not take effect for Android API level 33 and below, depending on the pre-34 provider(s) you have chosen)
`boolean isAutoSelectAllowed`	whether a create option will be automatically chosen if it is the only one available to the user (note that there is a chance that the credential provider does not support auto-select even if you turn this bit on)

Throws
`kotlin.NullPointerException`	If `requestJson` is null
`kotlin.IllegalArgumentException`	If `requestJson` is empty, or if it doesn't have a valid `user.name` defined according to the webauthn spec

Public methods

getClientDataHash

Added in 1.2.0

public final byte[] getClientDataHash()

a clientDataHash value to sign over in place of assembling and hashing clientDataJSON during the signature request; only meaningful when origin is set

getRequestJson

Added in 1.2.0

public final @NonNull String getRequestJson()

the request in JSON format in the standard webauthn web json.