# AuthenticationSignInOptions

Defined in: [react/src/auth/types.ts:166](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L166)

## Extends

- [`AuthClientSignInOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authclientsigninoptions/).[`AuthenticationClientOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/)

## Properties

### identityProvider?

> `optional` **identityProvider?**: `string` \| `URL`

Defined in: [react/src/auth/types.ts:96](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L96)

Identity provider URL.

#### Default

```ts
"https://id.ai/authorize"
```

#### Inherited from

[`AuthenticationClientOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/).[`identityProvider`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/#identityprovider)

***

### windowOpenerFeatures?

> `optional` **windowOpenerFeatures?**: `string`

Defined in: [react/src/auth/types.ts:98](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L98)

`window.open` features string for the identity provider popup.

#### Inherited from

[`AuthenticationClientOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/).[`windowOpenerFeatures`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/#windowopenerfeatures)

***

### openIdProvider?

> `optional` **openIdProvider?**: [`IdentityAttributeOpenIdProvider`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/identityattributeopenidprovider/)

Defined in: [react/src/auth/types.ts:107](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L107)

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](https://ic-reactor.b3pay.net/v3/libs/type-aliases/identityattributeopenidprovider/)

#### Inherited from

[`AuthenticationClientOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/).[`openIdProvider`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/#openidprovider)

***

### derivationOrigin?

> `optional` **derivationOrigin?**: `string` \| `URL`

Defined in: [react/src/auth/types.ts:116](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L116)

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`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/).[`derivationOrigin`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/#derivationorigin)

***

### storage?

> `optional` **storage?**: [`AuthClientStorageLike`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authclientstoragelike/)

Defined in: [react/src/auth/types.ts:118](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L118)

Persistent storage backend.

#### Default

```ts
IndexedDB
```

#### Inherited from

[`AuthenticationClientOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/).[`storage`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/#storage)

***

### keyType?

> `optional` **keyType?**: [`AuthClientKeyType`](https://ic-reactor.b3pay.net/v3/libs/type-aliases/authclientkeytype/)

Defined in: [react/src/auth/types.ts:123](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L123)

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

#### Default

```ts
"ECDSA"
```

#### Inherited from

[`AuthenticationClientOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/).[`keyType`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/#keytype)

***

### idleOptions?

> `optional` **idleOptions?**: [`AuthClientIdleOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authclientidleoptions/)

Defined in: [react/src/auth/types.ts:128](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L128)

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`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/).[`idleOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/#idleoptions)

***

### identity?

> `optional` **identity?**: `SignIdentity` \| `PartialIdentity`

Defined in: [react/src/auth/types.ts:130](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L130)

An existing identity to authenticate via delegation.

#### Inherited from

[`AuthenticationClientOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/).[`identity`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/#identity)

***

### transport?

> `optional` **transport?**: `"window"` \| `"redirect"`

Defined in: [react/src/auth/types.ts:136](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L136)

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

#### Default

```ts
"window"
```

#### Inherited from

[`AuthenticationClientOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/).[`transport`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/#transport)

***

### disableBrowserActivity?

> `optional` **disableBrowserActivity?**: `boolean`

Defined in: [react/src/auth/types.ts:145](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L145)

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

```ts
false
```

#### Inherited from

[`AuthenticationClientOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/).[`disableBrowserActivity`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationclientoptions/#disablebrowseractivity)

***

### maxTimeToLive?

> `optional` **maxTimeToLive?**: `bigint`

Defined in: [react/src/auth/types.ts:150](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L150)

The longest the delegation may last, in nanoseconds.

#### Inherited from

[`AuthClientSignInOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authclientsigninoptions/).[`maxTimeToLive`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authclientsigninoptions/#maxtimetolive)

***

### maxTimeToIdle?

> `optional` **maxTimeToIdle?**: `bigint`

Defined in: [react/src/auth/types.ts:158](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L158)

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`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authclientsigninoptions/).[`maxTimeToIdle`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authclientsigninoptions/#maxtimetoidle)

***

### targets?

> `optional` **targets?**: `Principal`[]

Defined in: [react/src/auth/types.ts:163](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L163)

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`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authclientsigninoptions/).[`targets`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authclientsigninoptions/#targets)

***

### onSuccess?

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

Defined in: [react/src/auth/types.ts:168](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L168)

#### Returns

`void` \| `Promise`\<`void`\>

***

### onError?

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

Defined in: [react/src/auth/types.ts:169](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/auth/types.ts#L169)

#### Parameters

##### error?

`string`

#### Returns

`void` \| `Promise`\<`void`\>