Skip to content

config properties webauthn properties relying_party

GitHub Action edited this page Dec 16, 2024 · 8 revisions

Version

v1.3.1

relying_party Type

object (relying_party)

relying_party Properties

Property Type Required Nullable Defined by
display_name string Optional cannot be null Config
id string Optional cannot be null Config
origins array Optional cannot be null Config

display_name

display_name is the service's name that some WebAuthn Authenticators will display to the user during registration and authentication ceremonies.

display_name

  • is optional

  • cannot be null

display_name Type

string

display_name Default Value

The default value is:

"Hanko Authentication Service"

id

id is the effective domain the passkey/WebAuthn credentials will be bound to.

id

  • is optional

  • cannot be null

id Type

string

id Default Value

The default value is:

"localhost"

origins

origins is a list of origins for which passkeys/WebAuthn credentials will be accepted by the server. Must include the protocol and can only be the effective domain, or a registrable domain suffix of the effective domain, as specified in the id. Except for localhost, the protocol must always be https for passkeys/WebAuthn to work. IP Addresses will not work.

For an Android application the origin must be the base64 url encoded SHA256 fingerprint of the signing certificate.

origins

  • is optional

  • cannot be null

origins Type

string[]

origins Constraints

minimum number of items: the minimum number of items for this array is: 1

origins Default Value

The default value is:

[
  "http://localhost:8888"
]
Clone this wiki locally