Package co.ankatech.keymanagement.client.auth.model

Class PublicKeyCreationOptions

java.lang.Object

co.ankatech.keymanagement.client.auth.model.PublicKeyCreationOptions

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class PublicKeyCreationOptions
extends Object

WebAuthn PublicKeyCredentialCreationOptionsJSON

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PublicKeyCreationOptions.AttestationEnum	The attestation conveyance preference
static class	PublicKeyCreationOptions.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ATTESTATION
static final String	SERIALIZED_NAME_AUTHENTICATOR_SELECTION
static final String	SERIALIZED_NAME_CHALLENGE
static final String	SERIALIZED_NAME_EXCLUDE_CREDENTIALS
static final String	SERIALIZED_NAME_EXTENSIONS
static final String	SERIALIZED_NAME_PUB_KEY_CRED_PARAMS
static final String	SERIALIZED_NAME_RP
static final String	SERIALIZED_NAME_TIMEOUT
static final String	SERIALIZED_NAME_USER

Constructor Summary

Constructors

Constructor	Description
PublicKeyCreationOptions()

Method Summary

Modifier and Type	Method	Description
PublicKeyCreationOptions	addExcludeCredentialsItem(PublicKeyCreationCredentialDescriptor excludeCredentialsItem)
PublicKeyCreationOptions	addPubKeyCredParamsItem(PublicKeyCreationCredentialParameters pubKeyCredParamsItem)
PublicKeyCreationOptions	attestation(PublicKeyCreationOptions.AttestationEnum attestation)
PublicKeyCreationOptions	authenticatorSelection(PublicKeyCreationAuthenticatorSelection authenticatorSelection)
PublicKeyCreationOptions	challenge(String challenge)
boolean	equals(Object o)
PublicKeyCreationOptions	excludeCredentials(List<PublicKeyCreationCredentialDescriptor> excludeCredentials)
PublicKeyCreationOptions	extensions(PublicKeyCreationExtensions extensions)
static PublicKeyCreationOptions	fromJson(String jsonString)	Create an instance of PublicKeyCreationOptions given an JSON string
PublicKeyCreationOptions.AttestationEnum	getAttestation()	The attestation conveyance preference
String	getAttestationAsString()	The wire value of attestation: what the server sent, verbatim.
PublicKeyCreationAuthenticatorSelection	getAuthenticatorSelection()	The authenticator requirements
String	getChallenge()	The single-use challenge, base64url
List<PublicKeyCreationCredentialDescriptor>	getExcludeCredentials()	The person's registered passkeys
PublicKeyCreationExtensions	getExtensions()	The client extensions requested
List<PublicKeyCreationCredentialParameters>	getPubKeyCredParams()	The accepted public key algorithms, preferred first
PublicKeyCreationRelyingParty	getRp()	The relying party
Long	getTimeout()	How long the ceremony may take, in milliseconds
PublicKeyCreationUser	getUser()	The user the passkey is created for
int	hashCode()
PublicKeyCreationOptions	pubKeyCredParams(List<PublicKeyCreationCredentialParameters> pubKeyCredParams)
PublicKeyCreationOptions	rp(PublicKeyCreationRelyingParty rp)
void	setAttestation(PublicKeyCreationOptions.AttestationEnum attestation)
void	setAuthenticatorSelection(PublicKeyCreationAuthenticatorSelection authenticatorSelection)
void	setChallenge(String challenge)
void	setExcludeCredentials(List<PublicKeyCreationCredentialDescriptor> excludeCredentials)
void	setExtensions(PublicKeyCreationExtensions extensions)
void	setPubKeyCredParams(List<PublicKeyCreationCredentialParameters> pubKeyCredParams)
void	setRp(PublicKeyCreationRelyingParty rp)
void	setTimeout(Long timeout)
void	setUser(PublicKeyCreationUser user)
PublicKeyCreationOptions	timeout(Long timeout)
String	toJson()	Convert an instance of PublicKeyCreationOptions to an JSON string
String	toString()
PublicKeyCreationOptions	user(PublicKeyCreationUser user)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found
static void	validateJsonElementAsCandidate(com.google.gson.JsonElement jsonElement)	Validates the JSON Element as a candidate of a oneOf schema: the checks of validateJsonElement(JsonElement), and the element carries no member this model does not declare.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_CHALLENGE

public static final String SERIALIZED_NAME_CHALLENGE

See Also:

• Constant Field Values

SERIALIZED_NAME_RP

public static final String SERIALIZED_NAME_RP

See Also:

• Constant Field Values

SERIALIZED_NAME_USER

public static final String SERIALIZED_NAME_USER

See Also:

• Constant Field Values

SERIALIZED_NAME_PUB_KEY_CRED_PARAMS

public static final String SERIALIZED_NAME_PUB_KEY_CRED_PARAMS

See Also:

• Constant Field Values

SERIALIZED_NAME_TIMEOUT

public static final String SERIALIZED_NAME_TIMEOUT

See Also:

• Constant Field Values

SERIALIZED_NAME_EXCLUDE_CREDENTIALS

public static final String SERIALIZED_NAME_EXCLUDE_CREDENTIALS

See Also:

• Constant Field Values

SERIALIZED_NAME_AUTHENTICATOR_SELECTION

public static final String SERIALIZED_NAME_AUTHENTICATOR_SELECTION

See Also:

• Constant Field Values

SERIALIZED_NAME_ATTESTATION

public static final String SERIALIZED_NAME_ATTESTATION

See Also:

• Constant Field Values

SERIALIZED_NAME_EXTENSIONS

public static final String SERIALIZED_NAME_EXTENSIONS

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

PublicKeyCreationOptions

public PublicKeyCreationOptions()

Method Details

getAttestationAsString

public String getAttestationAsString()

The wire value of attestation: what the server sent, verbatim.

• For a value this release declares, the same wire value the enum names.
• For a value it does not declare (one a later server added), the server's wire value verbatim, while getAttestation() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
• For an absent member, null.

Returns:

the wire value, or null when the member is absent

challenge

public PublicKeyCreationOptions challenge(@Nonnull
 String challenge)

getChallenge

@Nonnull
public String getChallenge()

The single-use challenge, base64url

Returns:

challenge

setChallenge

public void setChallenge(@Nonnull
 String challenge)

rp

public PublicKeyCreationOptions rp(@Nonnull
 PublicKeyCreationRelyingParty rp)

getRp

@Nonnull
public PublicKeyCreationRelyingParty getRp()

The relying party

Returns:

rp

setRp

public void setRp(@Nonnull
 PublicKeyCreationRelyingParty rp)

user

public PublicKeyCreationOptions user(@Nonnull
 PublicKeyCreationUser user)

getUser

@Nonnull
public PublicKeyCreationUser getUser()

The user the passkey is created for

Returns:

user

setUser

public void setUser(@Nonnull
 PublicKeyCreationUser user)

pubKeyCredParams

public PublicKeyCreationOptions pubKeyCredParams(@Nonnull
 List<PublicKeyCreationCredentialParameters> pubKeyCredParams)

addPubKeyCredParamsItem

public PublicKeyCreationOptions addPubKeyCredParamsItem(PublicKeyCreationCredentialParameters pubKeyCredParamsItem)

getPubKeyCredParams

@Nonnull
public List<PublicKeyCreationCredentialParameters> getPubKeyCredParams()

The accepted public key algorithms, preferred first

Returns:

pubKeyCredParams

setPubKeyCredParams

public void setPubKeyCredParams(@Nonnull
 List<PublicKeyCreationCredentialParameters> pubKeyCredParams)

timeout

public PublicKeyCreationOptions timeout(@Nonnull
 Long timeout)

getTimeout

@Nonnull
public Long getTimeout()

How long the ceremony may take, in milliseconds

Returns:

timeout

setTimeout

public void setTimeout(@Nonnull
 Long timeout)

excludeCredentials

public PublicKeyCreationOptions excludeCredentials(@Nonnull
 List<PublicKeyCreationCredentialDescriptor> excludeCredentials)

addExcludeCredentialsItem

public PublicKeyCreationOptions addExcludeCredentialsItem(PublicKeyCreationCredentialDescriptor excludeCredentialsItem)

getExcludeCredentials

@Nonnull
public List<PublicKeyCreationCredentialDescriptor> getExcludeCredentials()

The person's registered passkeys

Returns:

excludeCredentials

setExcludeCredentials

public void setExcludeCredentials(@Nonnull
 List<PublicKeyCreationCredentialDescriptor> excludeCredentials)

authenticatorSelection

public PublicKeyCreationOptions authenticatorSelection(@Nonnull
 PublicKeyCreationAuthenticatorSelection authenticatorSelection)

getAuthenticatorSelection

@Nonnull
public PublicKeyCreationAuthenticatorSelection getAuthenticatorSelection()

The authenticator requirements

Returns:

authenticatorSelection

setAuthenticatorSelection

public void setAuthenticatorSelection(@Nonnull
 PublicKeyCreationAuthenticatorSelection authenticatorSelection)

attestation

public PublicKeyCreationOptions attestation(@Nonnull
 PublicKeyCreationOptions.AttestationEnum attestation)

getAttestation

@Nonnull
public PublicKeyCreationOptions.AttestationEnum getAttestation()

The attestation conveyance preference

Returns:

attestation

setAttestation

public void setAttestation(@Nonnull
 PublicKeyCreationOptions.AttestationEnum attestation)

extensions

public PublicKeyCreationOptions extensions(@Nonnull
 PublicKeyCreationExtensions extensions)

getExtensions

@Nonnull
public PublicKeyCreationExtensions getExtensions()

The client extensions requested

Returns:

extensions

setExtensions

public void setExtensions(@Nonnull
 PublicKeyCreationExtensions extensions)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to PublicKeyCreationOptions

validateJsonElementAsCandidate

public static void validateJsonElementAsCandidate(com.google.gson.JsonElement jsonElement)
                                           throws IOException

Validates the JSON Element as a candidate of a oneOf schema: the checks of validateJsonElement(JsonElement), and the element carries no member this model does not declare. A oneOf schema without a discriminator tells its candidates apart by their member sets, so a candidate is matched on its closed member set.

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is not a PublicKeyCreationOptions

fromJson

public static PublicKeyCreationOptions fromJson(String jsonString)
                                         throws IOException

Create an instance of PublicKeyCreationOptions given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of PublicKeyCreationOptions

Throws:

IOException - if the JSON string is invalid with respect to PublicKeyCreationOptions

toJson

public String toJson()

Convert an instance of PublicKeyCreationOptions to an JSON string

Returns:

JSON string