AuthClientCreateOptions

Defined in: auth-client.ts:53

Options for creating an AuthClient.

Properties

derivationOrigin?

optional derivationOrigin?: string | URL

Defined in: auth-client.ts:89

Derivation origin for the identity provider.

See

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

---

identity?

optional identity?: SignIdentity | PartialIdentity

Defined in: auth-client.ts:57

An identity to authenticate via delegation.

---

identityProvider?

optional identityProvider?: string | URL

Defined in: auth-client.ts:83

Identity provider URL.

Default

"https://id.ai/authorize"

---

idleOptions?

optional idleOptions?: IdleOptions

Defined in: auth-client.ts:77

Idle timeout configuration.

Default

after 10 minutes, invalidates the identity

---

keyType?

optional keyType?: BaseKeyType

Defined in: auth-client.ts:71

Type of session key to generate on each sign-in.

Use 'Ed25519' when your storage provider does not support CryptoKey.

Default

'ECDSA'

---

openIdProvider?

optional openIdProvider?: OpenIdProvider

Defined in: auth-client.ts:102

OpenID provider for one-click sign-in. When set, the identity provider URL includes an openid search param so the user authenticates via the chosen provider (e.g. Google) instead of seeing Internet Identity directly.

---

storage?

optional storage?: AuthClientStorage

Defined in: auth-client.ts:63

Persistent storage backend. Defaults to IndexedDB.

Default

IdbStorage

---

windowOpenerFeatures?

optional windowOpenerFeatures?: string

Defined in: auth-client.ts:95

Window features string for the authentication popup.

Example

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