Package com.yubico.yubikit.fido.client

Class MultipleAssertionsAvailable

java.lang.Object

java.lang.Throwable

com.yubico.yubikit.fido.client.MultipleAssertionsAvailable

All Implemented Interfaces:

Serializable

public class MultipleAssertionsAvailable
extends Throwable

The request generated multiple assertions, and a choice must be made by the user. Once selected, call select(int) to get an assertion.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
int	getAssertionCount()	Get the number of assertions returned by the Authenticators.
List<PublicKeyCredentialUserEntity>	getUsers()	The list of users for which credentials are stored by the Authenticator.
PublicKeyCredential	select(int index)	Selects which assertion to use by index.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getAssertionCount

public int getAssertionCount()

Get the number of assertions returned by the Authenticators.

Returns:

the number of assertions available

getUsers

public List<PublicKeyCredentialUserEntity> getUsers()
                                             throws UserInformationNotAvailableError

The list of users for which credentials are stored by the Authenticator. The indexes of the user objects correspond to the value which should be passed to select() to select a response.

NOTE: If PIV/UV wasn't provided to the call to BasicWebAuthnClient.getAssertion(byte[], com.yubico.yubikit.fido.webauthn.PublicKeyCredentialRequestOptions, java.lang.String, char[], com.yubico.yubikit.core.application.CommandState) then user information may not be available, in which case this method will throw an exception.

Returns:

a list of available users.

Throws:

UserInformationNotAvailableError - in case PIN/UV wasn't provided

select

public PublicKeyCredential select(int index)

Selects which assertion to use by index. These indices correspond to those of the List returned by getUsers(). This method can only be called once to get a single response.

Parameters:

index - The index of the assertion to return.

Returns:

A WebAuthn public key credential.