RequestOpenIdIdentityAttributesParameters
Defined in: react/src/auth/types.ts:185
Extends
Section titled “Extends”Omit<RequestIdentityAttributesParameters,"openIdProvider">
Properties
Section titled “Properties”identityProvider?
Section titled “identityProvider?”
optionalidentityProvider?:string|URL
Defined in: react/src/auth/types.ts:96
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:98
window.open features string for the identity provider popup.
Inherited from
Section titled “Inherited from”AuthenticationClientOptions.windowOpenerFeatures
derivationOrigin?
Section titled “derivationOrigin?”
optionalderivationOrigin?: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.
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:118
Persistent storage backend.
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:123
Session key algorithm. Use "Ed25519" when the storage backend cannot
hold a CryptoKey.
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: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
Section titled “Inherited from”AuthenticationClientOptions.idleOptions
identity?
Section titled “identity?”
optionalidentity?:SignIdentity|PartialIdentity
Defined in: react/src/auth/types.ts:130
An existing identity to authenticate via delegation.
Inherited from
Section titled “Inherited from”AuthenticationClientOptions.identity
transport?
Section titled “transport?”
optionaltransport?:"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
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: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
Section titled “Default”falseInherited from
Section titled “Inherited from”AuthenticationClientOptions.disableBrowserActivity
keys:
string[]
Defined in: react/src/auth/types.ts:173
Inherited from
Section titled “Inherited from”RequestIdentityAttributesParameters.keys
nonce:
IdentityAttributeNonce
Defined in: react/src/auth/types.ts:174
Inherited from
Section titled “Inherited from”RequestIdentityAttributesParameters.nonce
signIn?
Section titled “signIn?”
optionalsignIn?:boolean
Defined in: react/src/auth/types.ts:179
Sign in as part of the same identity-provider interaction.
Default
Section titled “Default”trueInherited from
Section titled “Inherited from”RequestIdentityAttributesParameters.signIn
maxTimeToLive?
Section titled “maxTimeToLive?”
optionalmaxTimeToLive?:bigint
Defined in: react/src/auth/types.ts:180
Inherited from
Section titled “Inherited from”RequestIdentityAttributesParameters.maxTimeToLive
maxTimeToIdle?
Section titled “maxTimeToIdle?”
optionalmaxTimeToIdle?:bigint
Defined in: react/src/auth/types.ts:181
Inherited from
Section titled “Inherited from”RequestIdentityAttributesParameters.maxTimeToIdle
targets?
Section titled “targets?”
optionaltargets?:Principal[]
Defined in: react/src/auth/types.ts:182
Inherited from
Section titled “Inherited from”RequestIdentityAttributesParameters.targets
openIdProvider
Section titled “openIdProvider”openIdProvider:
IdentityAttributeOpenIdProvider
Defined in: react/src/auth/types.ts:198
Provider the requested keys are scoped to, producing
openid:<issuer>:<key>.
Passing one of the "google" | "apple" | "microsoft" aliases additionally
routes sign-in through that provider, so the user grants attribute access
in the same step. A raw issuer URL only scopes the keys.