AuthenticationManagerParameters
Defined in: react/src/auth/authentication-manager.ts:36
Extends
Section titled “Extends”Properties
Section titled “Properties”clientManager
Section titled “clientManager”clientManager:
ClientManager
Defined in: react/src/auth/authentication-manager.ts:37
authClient?
Section titled “authClient?”
optionalauthClient?:AuthClientLike
Defined in: react/src/auth/authentication-manager.ts:42
Bring your own client instance. When provided, IC Reactor never constructs one and never applies the options below to it.
internetIdentityId?
Section titled “internetIdentityId?”
optionalinternetIdentityId?:string
Defined in: react/src/auth/authentication-manager.ts:44
Canister ID of a locally deployed Internet Identity.
identityProvider?
Section titled “identityProvider?”
optionalidentityProvider?:string|URL
Defined in: react/src/auth/types.ts:99
Identity provider URL.
Default
Section titled “Default”"https://id.ai/authorize"Inherited from
Section titled “Inherited from”AuthenticationClientOptions.identityProvider
windowOpenerFeatures?
Section titled “windowOpenerFeatures?”
optionalwindowOpenerFeatures?:string
Defined in: react/src/auth/types.ts:101
window.open features string for the identity provider popup.
Inherited from
Section titled “Inherited from”AuthenticationClientOptions.windowOpenerFeatures
openIdProvider?
Section titled “openIdProvider?”
optionalopenIdProvider?:IdentityAttributeOpenIdProvider
Defined in: react/src/auth/types.ts:110
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.
IdentityAttributeOpenIdProvider
Inherited from
Section titled “Inherited from”AuthenticationClientOptions.openIdProvider
derivationOrigin?
Section titled “derivationOrigin?”
optionalderivationOrigin?:string|URL
Defined in: react/src/auth/types.ts:119
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.
https://github.com/dfinity/internet-identity/blob/main/docs/internet-identity-spec.adoc
Inherited from
Section titled “Inherited from”AuthenticationClientOptions.derivationOrigin
storage?
Section titled “storage?”
optionalstorage?:AuthClientStorageLike
Defined in: react/src/auth/types.ts:124
Persistent storage backend. @icp-sdk/auth v8 only: v10 drops it with a
one-time warning.
Default
Section titled “Default”IndexedDBInherited from
Section titled “Inherited from”AuthenticationClientOptions.storage
keyType?
Section titled “keyType?”
optionalkeyType?:AuthClientKeyType
Defined in: react/src/auth/types.ts:130
Session key algorithm. Use "Ed25519" when the storage backend cannot
hold a CryptoKey. @icp-sdk/auth v8 only: v10 drops it with a one-time
warning.
Default
Section titled “Default”"ECDSA"Inherited from
Section titled “Inherited from”AuthenticationClientOptions.keyType
idleOptions?
Section titled “idleOptions?”
optionalidleOptions?:AuthClientIdleOptions
Defined in: react/src/auth/types.ts:140
Idle timeout configuration. Pass { disableIdle: true } to opt out of the
default behaviour, which signs the user out and reloads after 10 minutes.
@icp-sdk/auth v8 only. v10 has no equivalent, so IC Reactor drops it
there with a one-time warning: on v10 the identity provider enforces the
idle limit, so pass maxTimeToIdle to login() and set
disableBrowserActivity instead.
Inherited from
Section titled “Inherited from”AuthenticationClientOptions.idleOptions
identity?
Section titled “identity?”
optionalidentity?:SignIdentity|PartialIdentity
Defined in: react/src/auth/types.ts:145
An existing identity to authenticate via delegation. @icp-sdk/auth v8
only: v10 drops it with a one-time warning.
Inherited from
Section titled “Inherited from”AuthenticationClientOptions.identity
transport?
Section titled “transport?”
optionaltransport?:"window"|"redirect"
Defined in: react/src/auth/types.ts:151
How the client talks to the identity provider. "redirect" requires
@icp-sdk/auth v8 or later and is ignored by older versions.
Default
Section titled “Default”"window"Inherited from
Section titled “Inherited from”AuthenticationClientOptions.transport
disableBrowserActivity?
Section titled “disableBrowserActivity?”
optionaldisableBrowserActivity?:boolean
Defined in: react/src/auth/types.ts:160
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
Section titled “Default”false