AuthClientLoginOptions

Defined in: auth-client.ts:102

Properties

allowPinAuthentication?

optional allowPinAuthentication: boolean

Defined in: auth-client.ts:116

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?

optional customValues: Record<string, unknown>

Defined in: auth-client.ts:138

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

---

derivationOrigin?

optional derivationOrigin: string | URL

Defined in: auth-client.ts:121

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?

optional identityProvider: string | URL

Defined in: auth-client.ts:107

Identity provider

Default

"https://identity.internetcomputer.org"

---

maxTimeToLive?

optional maxTimeToLive: bigint

Defined in: auth-client.ts:112

Expiration of the authentication in nanoseconds

Default

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

---

onError?

optional onError: OnErrorFunc

Defined in: auth-client.ts:134

Callback in case authentication fails

---

onSuccess?

optional onSuccess: OnSuccessFunc

Defined in: auth-client.ts:130

Callback once login has completed

---

windowOpenerFeatures?

optional windowOpenerFeatures: string

Defined in: auth-client.ts:126

Auth Window feature config string

Example

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