Package com.yubico.webauthn.data

Class RelyingPartyIdentity.RelyingPartyIdentityBuilder

java.lang.Object

com.yubico.webauthn.data.RelyingPartyIdentity.RelyingPartyIdentityBuilder

Enclosing class:

RelyingPartyIdentity

public static class RelyingPartyIdentity.RelyingPartyIdentityBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RelyingPartyIdentity.RelyingPartyIdentityBuilder.MandatoryStages

Method Summary

Modifier and Type	Method	Description
RelyingPartyIdentity	build()
RelyingPartyIdentity.RelyingPartyIdentityBuilder	icon(@NonNull java.util.Optional<java.net.URL> icon)	Deprecated. The icon property has been removed from WebAuthn Level 2.
RelyingPartyIdentity.RelyingPartyIdentityBuilder	icon(java.net.URL icon)	Deprecated. The icon property has been removed from WebAuthn Level 2.
RelyingPartyIdentity.RelyingPartyIdentityBuilder	id(@NonNull java.lang.String id)	A unique identifier for the Relying Party, which sets the RP ID.
RelyingPartyIdentity.RelyingPartyIdentityBuilder	name(@NonNull java.lang.String name)	The human-palatable name of the Relaying Party.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

icon

@Deprecated
public RelyingPartyIdentity.RelyingPartyIdentityBuilder icon(@NonNull
                                                             @NonNull java.util.Optional<java.net.URL> icon)

Deprecated.

The icon property has been removed from WebAuthn Level 2. This method will be removed in the next major version of the library.

A URL which resolves to an image associated with the entity. For example, this could be the Relying Party's logo.

This URL MUST be an a priori authenticated URL. Authenticators MUST accept and store a 128-byte minimum length for an icon member’s value. Authenticators MAY ignore an icon member’s value if its length is greater than 128 bytes. The URL’s scheme MAY be "data" to avoid fetches of the URL, at the cost of needing more storage.

icon

@Deprecated
public RelyingPartyIdentity.RelyingPartyIdentityBuilder icon(java.net.URL icon)

Deprecated.

The icon property has been removed from WebAuthn Level 2. This method will be removed in the next major version of the library.

A URL which resolves to an image associated with the entity. For example, this could be the Relying Party's logo.

This URL MUST be an a priori authenticated URL. Authenticators MUST accept and store a 128-byte minimum length for an icon member’s value. Authenticators MAY ignore an icon member’s value if its length is greater than 128 bytes. The URL’s scheme MAY be "data" to avoid fetches of the URL, at the cost of needing more storage.

name

public RelyingPartyIdentity.RelyingPartyIdentityBuilder name(@NonNull
                                                             @NonNull java.lang.String name)

The human-palatable name of the Relaying Party.

For example: "ACME Corporation", "Wonderful Widgets, Inc." or "ОАО Примертех".

Returns:

this.

id

public RelyingPartyIdentity.RelyingPartyIdentityBuilder id(@NonNull
                                                           @NonNull java.lang.String id)

A unique identifier for the Relying Party, which sets the RP ID.

This defines the domains where users' credentials are valid. See RP ID: scope for details and examples.

Returns:

this.

See Also:

RP ID, RP ID: scope

build

public RelyingPartyIdentity build()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object