Index
All Classes|All Packages|Constant Field Values|Serialized Form
A
- AttestationConveyancePreference - Enum Class in io.hanko.sdk.webauthn.protocol
-
WebAuthn Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation.
- AUTHENTICATION_FINALIZE - Static variable in class io.hanko.sdk.webauthn.Endpoints
-
Hanko API endpoint path for finalizing an authentication.
- AUTHENTICATION_INITIALIZE - Static variable in class io.hanko.sdk.webauthn.Endpoints
-
Hanko API endpoint path for initializing an authentication.
- AuthenticationInitializationOptions - Class in io.hanko.sdk.webauthn.api
-
Allows the setting of additional authenticator attributes for an
AuthenticationInitializationRequest
. - AuthenticationInitializationOptions() - Constructor for class io.hanko.sdk.webauthn.api.AuthenticationInitializationOptions
-
Construct AuthenticationInitializationOptions.
- AuthenticationInitializationOptions(AuthenticatorAttachment, UserVerificationRequirement) - Constructor for class io.hanko.sdk.webauthn.api.AuthenticationInitializationOptions
-
Construct AuthenticationInitializationOptions.
- AuthenticationInitializationRequest - Class in io.hanko.sdk.webauthn.api
-
Used to
initialize authentication
with an existing credential. - AuthenticationInitializationRequest() - Constructor for class io.hanko.sdk.webauthn.api.AuthenticationInitializationRequest
-
Construct an AuthenticationInitializationRequest
- AuthenticationInitializationRequest(AuthenticationInitializationOptions) - Constructor for class io.hanko.sdk.webauthn.api.AuthenticationInitializationRequest
-
Construct an AuthenticationInitializationRequest.
- AuthenticationInitializationRequest(AuthenticationInitializationUser, AuthenticationInitializationOptions) - Constructor for class io.hanko.sdk.webauthn.api.AuthenticationInitializationRequest
-
Construct an AuthenticationInitializationRequest
- AuthenticationInitializationUser - Class in io.hanko.sdk.webauthn.api
-
Represents the user on whose behalf authentication with an existing credential should be performed.
- AuthenticationInitializationUser() - Constructor for class io.hanko.sdk.webauthn.api.AuthenticationInitializationUser
-
Construct an AuthenticationInitializationUser.
- AuthenticationInitializationUser(String) - Constructor for class io.hanko.sdk.webauthn.api.AuthenticationInitializationUser
-
Construct an AuthenticationInitializationUser.
- Authenticator - Class in io.hanko.sdk.webauthn.api
-
Representation of an authenticator associated with an existing credential.
- Authenticator(String, String, AuthenticatorAttachment) - Constructor for class io.hanko.sdk.webauthn.api.Authenticator
-
Construct an Authenticator.
- AuthenticatorAttachment - Enum Class in io.hanko.sdk.webauthn.protocol
-
This enumeration's values describe authenticators' attachment modalities.
- AuthenticatorSelectionCriteria - Class in io.hanko.sdk.webauthn.protocol
-
WebAuthn Relying Parties may use the AuthenticatorSelectionCriteria to specify their requirements regarding authenticator attributes.
- AuthenticatorSelectionCriteria() - Constructor for class io.hanko.sdk.webauthn.protocol.AuthenticatorSelectionCriteria
-
Construct AuthenticatorSelectionCriteria.
- AuthenticatorSelectionCriteria(AuthenticatorAttachment, boolean, UserVerificationRequirement) - Constructor for class io.hanko.sdk.webauthn.protocol.AuthenticatorSelectionCriteria
-
Construct AuthenticatorSelectionCriteria.
C
- CredentialQuery - Class in io.hanko.sdk.webauthn.api
-
Represents a query for filtering and pagination of results when
retrieving a list of credentials
. - CredentialQuery() - Constructor for class io.hanko.sdk.webauthn.api.CredentialQuery
-
Construct a CredentialQuery.
- CredentialQuery(Integer, Integer, String) - Constructor for class io.hanko.sdk.webauthn.api.CredentialQuery
-
Construct a CredentialQuery
- CREDENTIALS - Static variable in class io.hanko.sdk.webauthn.Endpoints
-
Hanko API endpoint path for credentials.
- CredentialUpdateRequest - Class in io.hanko.sdk.webauthn.api
-
Request for updating a credential.
- CredentialUpdateRequest() - Constructor for class io.hanko.sdk.webauthn.api.CredentialUpdateRequest
-
Construct a CredentialUpdateRequest.
- CredentialUpdateRequest(String) - Constructor for class io.hanko.sdk.webauthn.api.CredentialUpdateRequest
-
Construct a CredentialUpdateRequest.
- CROSS_PLATFORM - Enum constant in enum class io.hanko.sdk.webauthn.protocol.AuthenticatorAttachment
-
Indicates cross-platform attachment.
D
- delete(String) - Method in class io.hanko.sdk.http.HankoHttpClient
-
Make a delete request to the Hanko API.
- DELETE - Enum constant in enum class io.hanko.sdk.http.HttpMethod
-
Represents a HTTP DELETE method.
- deleteCredential(String) - Method in class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Deletes the
WebAuthnCredential
with the specified credentialId. - deserialize(File, Class<T>) - Method in class io.hanko.sdk.json.HankoJsonParser
-
Deserialize File
f
into object of typeT
. - deserialize(InputStream, Class<T>) - Method in class io.hanko.sdk.json.HankoJsonParser
-
Deserialize InputStream
is
into object of typeT
. - deserialize(String, Class<T>) - Method in class io.hanko.sdk.json.HankoJsonParser
-
Deserialize String
s
into object of typeT
. - deserializeList(InputStream, Class<T>) - Method in class io.hanko.sdk.json.HankoJsonParser
-
Deserialize InputStream
is
into a list of objects of typeT
. - DIRECT - Enum constant in enum class io.hanko.sdk.webauthn.protocol.AttestationConveyancePreference
-
This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.
- DISCOURAGED - Enum constant in enum class io.hanko.sdk.webauthn.protocol.UserVerificationRequirement
-
This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow).
- displayName - Variable in class io.hanko.sdk.webauthn.api.User
-
The displayName of the user.
E
- Endpoints - Class in io.hanko.sdk.webauthn
-
Provides Hanko API endpoint paths.
F
- FinalizationResponse - Class in io.hanko.sdk.webauthn.api
-
Response to a registration, authentication or transaction finalization.
- FinalizationResponse(WebAuthnCredential) - Constructor for class io.hanko.sdk.webauthn.api.FinalizationResponse
-
Construct a FinalizationResponse
- finalizeAuthentication(String) - Method in class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Finalizes an authentication using the response from the WebAuthn API's navigator.credentials.get() call.
- finalizeRegistration(String) - Method in class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Finalizes a registration using the response from the WebAuthn API's navigator.credentials.create() call.
- finalizeTransaction(String) - Method in class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Finalizes the transaction request using the response from the WebAuthn API's navigator.credentials.get() call.
- fromValue(String) - Static method in enum class io.hanko.sdk.webauthn.protocol.AttestationConveyancePreference
-
Construct a AttestationConveyancePreference from a String value.
- fromValue(String) - Static method in enum class io.hanko.sdk.webauthn.protocol.AuthenticatorAttachment
-
Construct an AuthenticatorAttachment from a String value.
- fromValue(String) - Static method in enum class io.hanko.sdk.webauthn.protocol.UserVerificationRequirement
-
Construct a UserVerificationRequirement from a String value.
G
- get(String) - Method in class io.hanko.sdk.http.HankoHttpClient
-
Make a GET request to the Hanko API.
- GET - Enum constant in enum class io.hanko.sdk.http.HttpMethod
-
Represents a HTTP GET method.
- getAaguid() - Method in class io.hanko.sdk.webauthn.api.Authenticator
-
Get the AAGUID of this authenticator.
- getApiKeyId() - Method in class io.hanko.sdk.config.HankoClientConfig
-
Get the Hanko API key ID.
- getApiSecret() - Method in class io.hanko.sdk.config.HankoClientConfig
-
Get the Hanko API secret.
- getApiUrl() - Method in class io.hanko.sdk.config.HankoClientConfig
-
Get the Hanko API base URL.
- getAttachment() - Method in class io.hanko.sdk.webauthn.api.Authenticator
-
Get the
AuthenticatorAttachment
. - getAttachment() - Method in enum class io.hanko.sdk.webauthn.protocol.AuthenticatorAttachment
-
Return the
AuthenticatorAttachment.attachment
of the constant. - getAttestation() - Method in class io.hanko.sdk.webauthn.api.RegistrationInitializationOptions
-
Get the
AttestationConveyancePreference
. - getAuthenticator() - Method in class io.hanko.sdk.webauthn.api.WebAuthnCredential
-
Get the
Authenticator
used for registering the credential. - getAuthenticatorAttachment() - Method in class io.hanko.sdk.webauthn.api.AuthenticationInitializationOptions
-
Get the
AuthenticatorAttachment
. - getAuthenticatorAttachment() - Method in class io.hanko.sdk.webauthn.protocol.AuthenticatorSelectionCriteria
-
Get the
AuthenticatorAttachment
. - getAuthenticatorSelection() - Method in class io.hanko.sdk.webauthn.api.RegistrationInitializationOptions
-
Get the
AuthenticatorSelectionCriteria
. - getContent() - Method in exception io.hanko.sdk.exception.HankoApiException
-
Get the Hanko API response content.
- getContent() - Method in class io.hanko.sdk.http.HankoHttpResponse
-
Get the response content as String.
- getConveyancePreference() - Method in enum class io.hanko.sdk.webauthn.protocol.AttestationConveyancePreference
-
Return the
AttestationConveyancePreference.conveyancePreference
of the constant. - getCreatedAt() - Method in class io.hanko.sdk.webauthn.api.WebAuthnCredential
-
Get the time of credential creation.
- getCredential() - Method in class io.hanko.sdk.webauthn.api.FinalizationResponse
-
Get the
WebAuthnCredential
- getCredential(String) - Method in class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Retrieves the registered
WebAuthnCredential
with the specified credentialId. - getDisplayName() - Method in class io.hanko.sdk.webauthn.api.RegistrationInitializationUser
-
Get the displayName for the user.
- getId() - Method in class io.hanko.sdk.webauthn.api.User
-
Get the user
User.id
. - getId() - Method in class io.hanko.sdk.webauthn.api.WebAuthnCredential
-
Get the credential ID
- getLastUsed() - Method in class io.hanko.sdk.webauthn.api.WebAuthnCredential
-
Get the last time this credential was used for authentication
- getLogger() - Method in class io.hanko.sdk.http.HankoHttpClient
- getLogger() - Method in class io.hanko.sdk.http.HankoHttpClientBase
-
Get a logger
- getName() - Method in class io.hanko.sdk.webauthn.api.Authenticator
-
Get the authenticator name.
- getName() - Method in class io.hanko.sdk.webauthn.api.CredentialUpdateRequest
-
Get the name.
- getName() - Method in class io.hanko.sdk.webauthn.api.RegistrationInitializationUser
-
Get the username.
- getName() - Method in class io.hanko.sdk.webauthn.api.WebAuthnCredential
-
Get the name for the credential.
- getOptions() - Method in class io.hanko.sdk.webauthn.api.AuthenticationInitializationRequest
-
Get the options for initializing an authentication.
- getOptions() - Method in class io.hanko.sdk.webauthn.api.RegistrationInitializationRequest
-
Get the
RegistrationInitializationOptions
. - getPage() - Method in class io.hanko.sdk.webauthn.api.CredentialQuery
-
Get the page.
- getPageSize() - Method in class io.hanko.sdk.webauthn.api.CredentialQuery
-
Get the page size.
- getRequestPath() - Method in exception io.hanko.sdk.exception.HankoApiException
-
Get the original request path.
- getRequestPath() - Method in class io.hanko.sdk.http.HankoHttpResponse
-
Get the original request path for the related request.
- getStatus() - Method in exception io.hanko.sdk.exception.HankoApiException
-
Get the Hanko API HTTP response status.
- getStatusCode() - Method in class io.hanko.sdk.http.HankoHttpResponse
-
Get the HTTP status code of the response.
- getStream() - Method in class io.hanko.sdk.http.HankoHttpResponse
-
Get the response content as an InputStream.
- getTransaction() - Method in class io.hanko.sdk.webauthn.api.TransactionInitializationRequest
-
Get the transaction text.
- getUser() - Method in class io.hanko.sdk.webauthn.api.AuthenticationInitializationRequest
-
Get the user on whose behalf an authentication should be performed.
- getUser() - Method in class io.hanko.sdk.webauthn.api.RegistrationInitializationRequest
-
Get the
RegistrationInitializationUser
. - getUser() - Method in class io.hanko.sdk.webauthn.api.WebAuthnCredential
-
Get the
User
associated with the credential. - getUserid() - Method in class io.hanko.sdk.webauthn.api.CredentialQuery
-
Get the user ID.
- getUserVerification() - Method in class io.hanko.sdk.webauthn.api.AuthenticationInitializationOptions
-
Get the
UserVerificationRequirement
. - getUserVerification() - Method in class io.hanko.sdk.webauthn.protocol.AuthenticatorSelectionCriteria
-
Get the
UserVerificationRequirement
. - getUserVerification() - Method in enum class io.hanko.sdk.webauthn.protocol.UserVerificationRequirement
-
Return the
UserVerificationRequirement.userVerification
value of the constant.
H
- HankoApiConnectionException - Exception in io.hanko.sdk.exception
-
Exception occurring when no proper connection to the Hanko API can be established.
- HankoApiConnectionException(String, Throwable) - Constructor for exception io.hanko.sdk.exception.HankoApiConnectionException
-
Construct a new HankoApiConnectionException with the specified detail message and cause.
- HankoApiException - Exception in io.hanko.sdk.exception
-
Exception occurring when the Hanko API does not respond with a status code in the range 2xx.
- HankoApiException(String) - Constructor for exception io.hanko.sdk.exception.HankoApiException
-
Construct a new HankoApiException with the specified detail message.
- HankoApiException(String, Integer, String, String) - Constructor for exception io.hanko.sdk.exception.HankoApiException
-
Construct a new HankoApiException with the specified detail message, the Hanko API response status, the original request path and the Hanko API response content.
- HankoAuthenticationException - Exception in io.hanko.sdk.exception
-
Exception occurring when requests to the Hanko API cannot be authenticated (i.e.
- HankoAuthenticationException(String) - Constructor for exception io.hanko.sdk.exception.HankoAuthenticationException
-
Construct a new HankoAuthenticationException with the specified detail message.
- HankoAuthenticationException(String, Integer, String, String) - Constructor for exception io.hanko.sdk.exception.HankoAuthenticationException
-
Construct a new HankoAuthenticationException with the specified detail message, the Hanko API response status, the original request path and the Hanko API response content.
- HankoClientConfig - Class in io.hanko.sdk.config
-
Encapsulates main configuration parameters for creating a
HankoWebAuthnClient
. - HankoClientConfig(String, String) - Constructor for class io.hanko.sdk.config.HankoClientConfig
-
Construct a HankoClientConfig.
- HankoClientConfig(String, String, String) - Constructor for class io.hanko.sdk.config.HankoClientConfig
-
Construct a HankoClientConfig.
- HankoClientException - Exception in io.hanko.sdk.exception
-
Exception occurring on errors during serialization of request payloads or deserialization of Hanko API response payloads or HMAC calculation.
- HankoClientException(String, Throwable) - Constructor for exception io.hanko.sdk.exception.HankoClientException
-
Construct a new HankoClientException with the specified detail message and cause.
- HankoException - Exception in io.hanko.sdk.exception
-
Base Exception for all Hanko exceptions.
- HankoException(String) - Constructor for exception io.hanko.sdk.exception.HankoException
-
Construct a new HankoException with the specified detail message.
- HankoException(String, Throwable) - Constructor for exception io.hanko.sdk.exception.HankoException
-
Construct a new HankoException with the specified detail message and cause.
- HankoHttpClient - Class in io.hanko.sdk.http
-
Main
HankoHttpClientBase
extension providing methods aligned with HTTP verbs/operations used with the Hanko API. - HankoHttpClient(HankoClientConfig) - Constructor for class io.hanko.sdk.http.HankoHttpClient
-
Construct a HankoHttpClient.
- HankoHttpClient(HankoClientConfig, CloseableHttpClient) - Constructor for class io.hanko.sdk.http.HankoHttpClient
-
Construct a HankoHttpClient using a custom underlying
CloseableHttpClient
. - HankoHttpClientBase - Class in io.hanko.sdk.http
-
Abstract base client that performs actual requests to the Hanko API.
- HankoHttpClientBase(HankoClientConfig, CloseableHttpClient) - Constructor for class io.hanko.sdk.http.HankoHttpClientBase
-
Base constructor.
- HankoHttpResponse - Class in io.hanko.sdk.http
-
Encapsulates a Hanko API response.
- HankoHttpResponse(InputStream, int, String) - Constructor for class io.hanko.sdk.http.HankoHttpResponse
-
Create a HankoHttpResponse.
- HankoJsonParser - Class in io.hanko.sdk.json
-
Custom Json parser used for serializing Hanko API payloads and deserializing Hanko API responses.
- HankoJsonParser() - Constructor for class io.hanko.sdk.json.HankoJsonParser
-
Construct a HankoJsonParser.
- HankoNotFoundException - Exception in io.hanko.sdk.exception
-
Exception occurring if requested resources are not found by the Hanko API (i.e.
- HankoNotFoundException(String) - Constructor for exception io.hanko.sdk.exception.HankoNotFoundException
-
Construct a new HankoNotFoundException with the specified detail message.
- HankoNotFoundException(String, Integer, String, String) - Constructor for exception io.hanko.sdk.exception.HankoNotFoundException
-
Construct a new HankoNotFoundException with the specified detail message, the Hanko API response status, the original request path and the Hanko API response content.
- HankoWebAuthnClient - Class in io.hanko.sdk.webauthn
-
Main client type for performing registration, authentication, transactions and credential management.
- HankoWebAuthnClient(HankoClientConfig) - Constructor for class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Construct a HankoWebAuthnClient.
- HankoWebAuthnClient(HankoClientConfig, CloseableHttpClient) - Constructor for class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Construct a HankoWebAuthnClient using a custom underlying
CloseableHttpClient
. - HankoWebAuthnClient(HankoHttpClient) - Constructor for class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Construct a HankoWebAuthnClient using a custom
HankoHttpClient
. - HmacUtil - Class in io.hanko.sdk.util
-
Utility class for providing an authorization header to use for making authenticated calls to the Hanko API.
- HttpMethod - Enum Class in io.hanko.sdk.http
-
Enumeration of HTTP methods.
I
- id - Variable in class io.hanko.sdk.webauthn.api.User
-
The ID of the user.
- INDIRECT - Enum constant in enum class io.hanko.sdk.webauthn.protocol.AttestationConveyancePreference
-
This value indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements.
- initializeAuthentication(AuthenticationInitializationRequest) - Method in class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Initializes an authentication with a registered credential using an
AuthenticationInitializationRequest
. - initializeRegistration(RegistrationInitializationRequest) - Method in class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Initializes the registration of a new credential using a
RegistrationInitializationRequest
. - initializeTransaction(TransactionInitializationRequest) - Method in class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Initializes a transaction.
- io.hanko.sdk.config - package io.hanko.sdk.config
- io.hanko.sdk.exception - package io.hanko.sdk.exception
- io.hanko.sdk.http - package io.hanko.sdk.http
- io.hanko.sdk.json - package io.hanko.sdk.json
- io.hanko.sdk.util - package io.hanko.sdk.util
- io.hanko.sdk.webauthn - package io.hanko.sdk.webauthn
- io.hanko.sdk.webauthn.api - package io.hanko.sdk.webauthn.api
- io.hanko.sdk.webauthn.protocol - package io.hanko.sdk.webauthn.protocol
- isRequireResidentKey() - Method in class io.hanko.sdk.webauthn.protocol.AuthenticatorSelectionCriteria
-
Get the resident key requirement.
- isResidentKey() - Method in class io.hanko.sdk.webauthn.api.WebAuthnCredential
-
Indicates whether this credential was registered as a resident credential/client-side discoverable credential
- isUserVerification() - Method in class io.hanko.sdk.webauthn.api.WebAuthnCredential
-
Indicates whether this credential was registered with a successful user verification process.
L
- listCredentials(CredentialQuery) - Method in class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Retrieves a list of registered
WebAuthnCredential
s.
M
- makeAuthorizationHeader(String, String, String, String, String) - Static method in class io.hanko.sdk.util.HmacUtil
-
Construct a suitable authorization header for a request to the Hanko API.
- makeRequest(HttpMethod, String) - Method in class io.hanko.sdk.http.HankoHttpClientBase
-
Performs a request without a request body to the Hanko API.
- makeRequest(HttpMethod, String, String) - Method in class io.hanko.sdk.http.HankoHttpClientBase
-
Performs a request with a request body to the Hanko API.
N
- name - Variable in class io.hanko.sdk.webauthn.api.User
-
The name of the user.
- NONE - Enum constant in enum class io.hanko.sdk.webauthn.protocol.AttestationConveyancePreference
-
This value indicates that the Relying Party is not interested in authenticator attestation.
P
- PLATFORM - Enum constant in enum class io.hanko.sdk.webauthn.protocol.AuthenticatorAttachment
-
Indicates platform attachment.
- post(String, String) - Method in class io.hanko.sdk.http.HankoHttpClient
-
Make a POST request to the Hanko API.
- POST - Enum constant in enum class io.hanko.sdk.http.HttpMethod
-
Represents a HTTP POST method.
- PREFERRED - Enum constant in enum class io.hanko.sdk.webauthn.protocol.UserVerificationRequirement
-
This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the UV flag set.
- put(String, String) - Method in class io.hanko.sdk.http.HankoHttpClient
-
Make a PUT request to the Hanko API.
- PUT - Enum constant in enum class io.hanko.sdk.http.HttpMethod
-
Represents a HTTP PUT method.
R
- REGISTRATION_FINALIZE - Static variable in class io.hanko.sdk.webauthn.Endpoints
-
Hanko API endpoint path for finalizing a registration.
- REGISTRATION_INITIALIZE - Static variable in class io.hanko.sdk.webauthn.Endpoints
-
Hanko API endpoint path for initializing a registration.
- RegistrationInitializationOptions - Class in io.hanko.sdk.webauthn.api
-
Allows the setting of additional authenticator attributes for a
RegistrationInitializationRequest
. - RegistrationInitializationOptions() - Constructor for class io.hanko.sdk.webauthn.api.RegistrationInitializationOptions
-
Construct RegistrationInitializationOptions.
- RegistrationInitializationOptions(AuthenticatorSelectionCriteria, AttestationConveyancePreference) - Constructor for class io.hanko.sdk.webauthn.api.RegistrationInitializationOptions
-
Construct RegistrationInitializationOptions.
- RegistrationInitializationRequest - Class in io.hanko.sdk.webauthn.api
-
Used to initialize a
credential registration operation
. - RegistrationInitializationRequest(RegistrationInitializationUser) - Constructor for class io.hanko.sdk.webauthn.api.RegistrationInitializationRequest
-
Create a RegistrationInitializationRequest
- RegistrationInitializationRequest(RegistrationInitializationUser, RegistrationInitializationOptions) - Constructor for class io.hanko.sdk.webauthn.api.RegistrationInitializationRequest
-
Create a RegistrationInitializationRequest
- RegistrationInitializationUser - Class in io.hanko.sdk.webauthn.api
-
Represents the user on whose behalf registration of a credential should be performed.
- RegistrationInitializationUser(String, String) - Constructor for class io.hanko.sdk.webauthn.api.RegistrationInitializationUser
-
Construct a RegistrationInitializationUser.
- RegistrationInitializationUser(String, String, String) - Constructor for class io.hanko.sdk.webauthn.api.RegistrationInitializationUser
-
Construct a RegistrationInitializationUser.
- REQUIRED - Enum constant in enum class io.hanko.sdk.webauthn.protocol.UserVerificationRequirement
-
This value indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the UV flag set.
S
- serialize(T) - Method in class io.hanko.sdk.json.HankoJsonParser
-
Serialize instance of type
T
to a String. - setAttestation(AttestationConveyancePreference) - Method in class io.hanko.sdk.webauthn.api.RegistrationInitializationOptions
-
Set the
AttestationConveyancePreference
. - setAuthenticatorAttachment(AuthenticatorAttachment) - Method in class io.hanko.sdk.webauthn.api.AuthenticationInitializationOptions
-
Set the
AuthenticatorAttachment
. - setAuthenticatorAttachment(AuthenticatorAttachment) - Method in class io.hanko.sdk.webauthn.protocol.AuthenticatorSelectionCriteria
-
Set the
AuthenticatorAttachment
. - setAuthenticatorSelection(AuthenticatorSelectionCriteria) - Method in class io.hanko.sdk.webauthn.api.RegistrationInitializationOptions
-
Set the
AuthenticatorSelectionCriteria
. - setDisplayName(String) - Method in class io.hanko.sdk.webauthn.api.RegistrationInitializationUser
-
Set the displayName for the user.
- setId(String) - Method in class io.hanko.sdk.webauthn.api.User
-
Set the user
User.id
. - setName(String) - Method in class io.hanko.sdk.webauthn.api.CredentialUpdateRequest
-
Set the name.
- setOptions(AuthenticationInitializationOptions) - Method in class io.hanko.sdk.webauthn.api.AuthenticationInitializationRequest
-
Set the options for initializing an authentication.
- setOptions(RegistrationInitializationOptions) - Method in class io.hanko.sdk.webauthn.api.RegistrationInitializationRequest
- setPage(Integer) - Method in class io.hanko.sdk.webauthn.api.CredentialQuery
-
Set the page to return from the result set.
- setPageSize(Integer) - Method in class io.hanko.sdk.webauthn.api.CredentialQuery
-
Set the page size.
- setRequireResidentKey(boolean) - Method in class io.hanko.sdk.webauthn.protocol.AuthenticatorSelectionCriteria
-
Get the resident key requirement.
- setUser(AuthenticationInitializationUser) - Method in class io.hanko.sdk.webauthn.api.AuthenticationInitializationRequest
-
Set the user on whose behalf an authentication should be performed.
- setUserid(String) - Method in class io.hanko.sdk.webauthn.api.CredentialQuery
-
Set the user ID.
- setUserVerification(UserVerificationRequirement) - Method in class io.hanko.sdk.webauthn.api.AuthenticationInitializationOptions
-
Set the
UserVerificationRequirement
. - setUserVerification(UserVerificationRequirement) - Method in class io.hanko.sdk.webauthn.protocol.AuthenticatorSelectionCriteria
-
Set the
UserVerificationRequirement
. - success() - Method in class io.hanko.sdk.http.HankoHttpResponse
-
Check whether the response indicates a successful request, i.e.: whether the response status code is in the 2xx range.
T
- toQueryString() - Method in class io.hanko.sdk.webauthn.api.CredentialQuery
-
Return a query string for the query.
- TRANSACTION_FINALIZE - Static variable in class io.hanko.sdk.webauthn.Endpoints
-
Hanko API endpoint path for finalizing a transaction.
- TRANSACTION_INITIALIZE - Static variable in class io.hanko.sdk.webauthn.Endpoints
-
Hanko API endpoint path for initializing a transaction.
- TransactionInitializationRequest - Class in io.hanko.sdk.webauthn.api
-
Used to
initialize a transaction operation
. - TransactionInitializationRequest(String) - Constructor for class io.hanko.sdk.webauthn.api.TransactionInitializationRequest
-
Construct a TransactionInitializationRequest.
U
- updateCredential(String, CredentialUpdateRequest) - Method in class io.hanko.sdk.webauthn.HankoWebAuthnClient
-
Updates the
WebAuthnCredential
with the specified credentialId. - User - Class in io.hanko.sdk.webauthn.api
-
Base representation of a user on whose behalf registration and authentication are performed with the Hanko API.
- User() - Constructor for class io.hanko.sdk.webauthn.api.User
-
Construct a User.
- User(String, String, String) - Constructor for class io.hanko.sdk.webauthn.api.User
-
Construct a user
- UserVerificationRequirement - Enum Class in io.hanko.sdk.webauthn.protocol
-
A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs.
V
- valueOf(String) - Static method in enum class io.hanko.sdk.http.HttpMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.hanko.sdk.webauthn.protocol.AttestationConveyancePreference
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.hanko.sdk.webauthn.protocol.AuthenticatorAttachment
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.hanko.sdk.webauthn.protocol.UserVerificationRequirement
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.hanko.sdk.http.HttpMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.hanko.sdk.webauthn.protocol.AttestationConveyancePreference
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.hanko.sdk.webauthn.protocol.AuthenticatorAttachment
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.hanko.sdk.webauthn.protocol.UserVerificationRequirement
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WebAuthnCredential - Class in io.hanko.sdk.webauthn.api
-
Representation of a credential.
- WebAuthnCredential(String, User, String, String, boolean, String, boolean, Authenticator) - Constructor for class io.hanko.sdk.webauthn.api.WebAuthnCredential
-
Construct a WebAuthnCredential.
All Classes|All Packages|Constant Field Values|Serialized Form