Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AuthClientLoginOptions

Hierarchy

  • AuthClientLoginOptions

Index

Properties

allowPinAuthentication?: boolean

If present, indicates whether or not the Identity Provider should allow the user to authenticate and/or register using a temporary key/PIN identity. Authenticating dapps may want to prevent users from using Temporary keys/PIN identities because Temporary keys/PIN identities are less secure than Passkeys (webauthn credentials) and because Temporary keys/PIN identities generally only live in a browser database (which may get cleared by the browser/OS).

customValues?: Record<string, unknown>

Extra values to be passed in the login request during the authorize-ready phase

derivationOrigin?: string | URL

Origin for Identity Provider to use while generating the delegated identity. For II, the derivation origin must authorize this origin by setting a record at <derivation-origin>/.well-known/ii-alternative-origins.

see

https://github.com/dfinity/internet-identity/blob/main/docs/internet-identity-spec.adoc

identityProvider?: string | URL

Identity provider

default

"https://identity.ic0.app"

maxTimeToLive?: bigint

Expiration of the authentication in nanoseconds

default

BigInt(8) hours * BigInt(3_600_000_000_000) nanoseconds

onError?: OnErrorFunc

Callback in case authentication fails

onSuccess?: OnSuccessFunc

Callback once login has completed

windowOpenerFeatures?: string

Auth Window feature config string

example

"toolbar=0,location=0,menubar=0,width=500,height=500,left=100,top=100"

Generated using TypeDoc