AuthenticationSignInOptions

Defined in: react/src/auth/types.ts:166

Extends

AuthClientSignInOptions.AuthenticationClientOptions

Properties

identityProvider?

optional identityProvider?: string | URL

Defined in: react/src/auth/types.ts:96

Identity provider URL.

Default

"https://id.ai/authorize"

Inherited from

AuthenticationClientOptions.identityProvider

windowOpenerFeatures?

optional windowOpenerFeatures?: string

Defined in: react/src/auth/types.ts:98

window.open features string for the identity provider popup.

Inherited from

AuthenticationClientOptions.windowOpenerFeatures

openIdProvider?

optional openIdProvider?: IdentityAttributeOpenIdProvider

Defined in: react/src/auth/types.ts:107

Provider for one-click sign-in.

Only the "google" | "apple" | "microsoft" aliases reach the auth client. Any other value is dropped here and has no effect — raw issuer URLs are only meaningful on requestOpenId, where they scope the requested keys.

See

IdentityAttributeOpenIdProvider

Inherited from

AuthenticationClientOptions.openIdProvider

derivationOrigin?

optional derivationOrigin?: string | URL

Defined in: react/src/auth/types.ts:116

Derivation origin for the identity provider.

Required when the app is served from more than one origin (e.g. a custom domain plus <canisterId>.icp0.io) and every origin must resolve to the same principal.

See

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

Inherited from

AuthenticationClientOptions.derivationOrigin

storage?

optional storage?: AuthClientStorageLike

Defined in: react/src/auth/types.ts:118

Persistent storage backend.

Default

IndexedDB

Inherited from

AuthenticationClientOptions.storage

keyType?

optional keyType?: AuthClientKeyType

Defined in: react/src/auth/types.ts:123

Session key algorithm. Use "Ed25519" when the storage backend cannot hold a CryptoKey.

Default

"ECDSA"

Inherited from

AuthenticationClientOptions.keyType

idleOptions?

optional idleOptions?: AuthClientIdleOptions

Defined in: react/src/auth/types.ts:128

Idle timeout configuration. Pass { disableIdle: true } to opt out of the default behaviour, which signs the user out and reloads after 10 minutes.

Inherited from

AuthenticationClientOptions.idleOptions

identity?

optional identity?: SignIdentity | PartialIdentity

Defined in: react/src/auth/types.ts:130

An existing identity to authenticate via delegation.

Inherited from

AuthenticationClientOptions.identity

transport?

optional transport?: "window" | "redirect"

Defined in: react/src/auth/types.ts:136

How the client talks to the identity provider. "redirect" requires @icp-sdk/auth v8 or later and is ignored by older versions.

Default

"window"

Inherited from

AuthenticationClientOptions.transport

disableBrowserActivity?

optional disableBrowserActivity?: boolean

Defined in: react/src/auth/types.ts:145

Stops a v10 client from watching the page for signs of activity, so only requests keep the session in use.

@icp-sdk/auth v10 only. v8 has no equivalent, so IC Reactor drops it there with a one-time warning. On v8, idleOptions controls idle handling.

Default

false

Inherited from

AuthenticationClientOptions.disableBrowserActivity

maxTimeToLive?

optional maxTimeToLive?: bigint

Defined in: react/src/auth/types.ts:150

The longest the delegation may last, in nanoseconds.

Inherited from

AuthClientSignInOptions.maxTimeToLive

maxTimeToIdle?

optional maxTimeToIdle?: bigint

Defined in: react/src/auth/types.ts:158

How long a signed-in user may be idle before the sign-in ends, in nanoseconds.

@icp-sdk/auth v10 only. v8’s sign-in has no idle limit, so IC Reactor drops it there with a one-time warning. On v8, set idleOptions instead.

Inherited from

AuthClientSignInOptions.maxTimeToIdle

targets?

optional targets?: Principal[]

Defined in: react/src/auth/types.ts:163

Canisters the delegation is restricted to. @icp-sdk/auth v8 only: v10 ignores it, and IC Reactor warns when it is set for a v10 client.

Inherited from

AuthClientSignInOptions.targets

onSuccess?

optional onSuccess?: () => void | Promise<void>

Defined in: react/src/auth/types.ts:168

Returns

void | Promise<void>

onError?

optional onError?: (error?) => void | Promise<void>

Defined in: react/src/auth/types.ts:169

Parameters

error?

string

Returns

void | Promise<void>