# Sign-in SDK reference (/sdk/sign-in-api)



{/* AUTO-GENERATED by scripts/generate-sign-in-docs.mjs from @alternatefutures/ac-auth@0.2.0, @alternatefutures/ac-auth-react@0.2.0, @alternatefutures/ac-auth-next@0.2.0, @alternatefutures/ac-auth-js@0.2.0 - do not edit by hand. */}

**@alternatefutures/ac-auth-sdk-monorepo** • **Docs**

***

# @alternatefutures/ac-auth-sdk-monorepo [#alternatefuturesac-auth-sdk-monorepo]

## Modules [#modules]

* [ac-auth-js/src](ac-auth-js/src/README.md)
* [ac-auth-next/src](ac-auth-next/src/README.md)
* [ac-auth-next/src/proxy](ac-auth-next/src/proxy/README.md)
* [ac-auth-next/src/react](ac-auth-next/src/react/README.md)
* [ac-auth-react/src](ac-auth-react/src/README.md)
* [ac-auth/src](ac-auth/src/README.md)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../README.md) / ac-auth-js/src

# ac-auth-js/src [#ac-auth-jssrc]

@alternatefutures/ac-auth-js

Sign in with Alternate Clouds as an Auth.js provider (next-auth v5,
@auth/core, and every framework Auth.js supports: SvelteKit, SolidStart,
Express, ...). One line in `providers`, nothing else:

import NextAuth from 'next-auth';
import AlternateClouds from '@alternatefutures/ac-auth-js';

export const \{ handlers, auth, signIn, signOut } = NextAuth(\{
providers: \[AlternateClouds(\{ clientId: process.env.AUTH\_ALTERNATE\_CLOUDS\_ID })],
});

The callback URL to register on the client is
`<origin>/api/auth/callback/alternate-clouds`.

What the provider asks Auth.js for, and why:

* `type: "oidc"`: discovery, ID token verification (EdDSA / ES256 through
  oauth4webapi) and the userinfo fallback come from the issuer document.
* `checks: ["pkce", "state", "nonce"]`: the issuer requires all three.
* `client.token_endpoint_auth_method`: `none` for a public client (no
  secret), `client_secret_basic` (the issuer's default) when a secret is
  given. Auth.js would otherwise assume Basic and the issuer would answer
  `invalid_client` for a public client.
* `profile()`: the Auth.js user is keyed on the wallet DID when the user
  has a verified wallet, else the subject, the same rule as
  `@alternatefutures/ac-auth` (`userFromClaims`).

## Index [#index]

### Interfaces [#interfaces]

* [AlternateCloudsOptions](interfaces/AlternateCloudsOptions.md)

### Type Aliases [#type-aliases]

* [AlternateCloudsProfile](type-aliases/AlternateCloudsProfile.md)

### Variables [#variables]

* [ALTERNATE\_CLOUDS\_PROVIDER\_ID](variables/ALTERNATE_CLOUDS_PROVIDER_ID.md)
* [BRAND\_COLOR](variables/BRAND_COLOR.md)

### Functions [#functions]

* [AlternateClouds](functions/AlternateClouds.md)

## References [#references]

### default [#default]

Renames and re-exports [AlternateClouds](functions/AlternateClouds.md)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-js/src](../README.md) / AlternateClouds

# Function: AlternateClouds() [#function-alternateclouds]

> **AlternateClouds**(`options`): `OIDCConfig`\<[`AlternateCloudsProfile`](../type-aliases/AlternateCloudsProfile.md)>

## Parameters [#parameters]

• **options**: [`AlternateCloudsOptions`](../interfaces/AlternateCloudsOptions.md) = `{}`

## Returns [#returns]

`OIDCConfig`\<[`AlternateCloudsProfile`](../type-aliases/AlternateCloudsProfile.md)>

## Defined in [#defined-in]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:51](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-js/src/index.ts#L51)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-js/src](../README.md) / AlternateCloudsOptions

# Interface: AlternateCloudsOptions [#interface-alternatecloudsoptions]

## Extends [#extends]

* `OIDCUserConfig`\<[`AlternateCloudsProfile`](../type-aliases/AlternateCloudsProfile.md)>

## Properties [#properties]

### \[customFetch]\()? [#customfetch]

> `optional&#x60; &#x2A;*\[customFetch]**: (`input`, `init`?) => `Promise`\<`Response`>(`input`, `init`?) => `Promise`\<`Response`>

[MDN Reference](https://developer.mozilla.org/docs/Web/API/fetch)

#### Parameters [#parameters-1]

• **input**: `RequestInfo` | `URL`

• &#x2A;*init?**: `RequestInit`

#### Returns [#returns-1]

`Promise`\<`Response`>

#### Parameters [#parameters-2]

• **input**: `string` | `Request` | `URL`

• &#x2A;*init?**: `RequestInit`

#### Returns [#returns-2]

`Promise`\<`Response`>

#### See [#see]

#### Inherited from [#inherited-from]

`OIDCUserConfig.[customFetch]`

#### Defined in [#defined-in-1]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:163

***

### account? [#account]

> `optional` **account**: `AccountCallback`

Receives the full TokenSet returned by the OAuth provider, and returns a subset.
It is used to create the account associated with a user in the database.

:::note
You need to adjust your database's [Account model](https://authjs.dev/reference/core/adapters#account) to match the returned properties.
Check out the documentation of your [database adapter](https://authjs.dev/reference/core/adapters) for more information.
:::

Defaults to: `access_token`, `id_token`, `refresh_token`, `expires_at`, `scope`, `token_type`, `session_state`

#### Example [#example]

```ts
import GitHub from "@auth/core/providers/github"
// ...
GitHub({
  account(account) {
    // https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens#refreshing-a-user-access-token-with-a-refresh-token
    const refresh_token_expires_at =
      Math.floor(Date.now() / 1000) + Number(account.refresh_token_expires_in)
    return {
      access_token: account.access_token,
      expires_at: account.expires_at,
      refresh_token: account.refresh_token,
      refresh_token_expires_at
    }
  }
})
```

#### See [#see-1]

* [Database Adapter: Account model](https://authjs.dev/reference/core/adapters#account)
* [https://openid.net/specs/openid-connect-core-1\_0.html#TokenResponse](https://openid.net/specs/openid-connect-core-1_0.html#TokenResponse)
* [https://www.ietf.org/rfc/rfc6749.html#section-5.1](https://www.ietf.org/rfc/rfc6749.html#section-5.1)

#### Inherited from [#inherited-from-1]

`OIDCUserConfig.account`

#### Defined in [#defined-in-2]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:124

***

### allowDangerousEmailAccountLinking? [#allowdangerousemailaccountlinking]

> `optional` **allowDangerousEmailAccountLinking**: `boolean`

Normally, when you sign in with an OAuth provider and another account
with the same email address already exists,
the accounts are not linked automatically.

Automatic account linking on sign in is not secure
between arbitrary providers and is disabled by default.
Learn more in our [Security FAQ](https://authjs.dev/concepts#security).

However, it may be desirable to allow automatic account linking if you trust that the provider involved has securely verified the email address
associated with the account. Set `allowDangerousEmailAccountLinking: true`
to enable automatic account linking.

#### Inherited from [#inherited-from-2]

`OIDCUserConfig.allowDangerousEmailAccountLinking`

#### Defined in [#defined-in-3]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:160

***

### authorization? [#authorization]

> `optional` **authorization**: `any`

The login process will be initiated by sending the user to this URL.

[Authorization endpoint](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1)

#### Inherited from [#inherited-from-3]

`OIDCUserConfig.authorization`

#### Defined in [#defined-in-4]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:77

***

### checks? [#checks]

> `optional` **checks**: (`"pkce"` | `"state"` | `"none"` | `"nonce"`)\[]

#### Inherited from [#inherited-from-4]

`OIDCUserConfig.checks`

#### Defined in [#defined-in-5]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:173

***

### client? [#client]

> `optional` **client**: `Partial`\<`Client` & `object`>

Pass overrides to the underlying OAuth library.
See [`oauth4webapi` client](https://github.com/panva/oauth4webapi/blob/main/docs/interfaces/Client.md) for details.

#### Inherited from [#inherited-from-5]

`OIDCUserConfig.client`

#### Defined in [#defined-in-6]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:143

***

### clientId? [#clientid]

> `optional` **clientId**: `string`

#### Inherited from [#inherited-from-6]

`OIDCUserConfig.clientId`

#### Defined in [#defined-in-7]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:137

***

### clientSecret? [#clientsecret]

> `optional` **clientSecret**: `string`

#### Inherited from [#inherited-from-7]

`OIDCUserConfig.clientSecret`

#### Defined in [#defined-in-8]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:138

***

### id? [#id]

> `optional` **id**: `string`

Identifies the provider when you want to sign in to
a specific provider.

#### Example [#example-1]

```ts
signIn('github') // "github" is the provider ID
```

#### Inherited from [#inherited-from-8]

`OIDCUserConfig.id`

#### Defined in [#defined-in-9]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:58

***

### idToken? [#idtoken]

> `optional` **idToken**: `boolean`

If set to `false`, the `userinfo_endpoint` will be fetched for the user data.

#### Note [#note]

An `id_token` is still required to be returned during the authorization flow.

#### Inherited from [#inherited-from-9]

`OIDCUserConfig.idToken`

#### Defined in [#defined-in-10]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:178

***

### issuer? [#issuer]

> `optional` **issuer**: `string`

Issuer identifier. Default the production issuer; use the staging issuer for a staging client.

#### Overrides [#overrides]

`OIDCUserConfig.issuer`

#### Defined in [#defined-in-11]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:41](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-js/src/index.ts#L41)

***

### jwks\_endpoint [#jwks_endpoint]

> **jwks\_endpoint**: `any`

#### Inherited from [#inherited-from-10]

`OIDCUserConfig.jwks_endpoint`

***

### name? [#name]

> `optional` **name**: `string`

The name of the provider. shown on the default sign in page.

#### Inherited from [#inherited-from-11]

`OIDCUserConfig.name`

#### Defined in [#defined-in-12]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:60

***

### profile? [#profile]

> `optional` **profile**: `ProfileCallback`\<[`IdTokenClaims`](../../../ac-auth/src/interfaces/IdTokenClaims.md)>

Receives the full Profile returned by the OAuth provider, and returns a subset.
It is used to create the user in the database.

Defaults to: `id`, `email`, `name`, `image`

#### See [#see-2]

[Database Adapter: User model](https://authjs.dev/reference/core/adapters#user)

#### Inherited from [#inherited-from-12]

`OIDCUserConfig.profile`

#### Defined in [#defined-in-13]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:89

***

### redirectProxyUrl? [#redirectproxyurl]

> `optional` **redirectProxyUrl**: `string`

#### Inherited from [#inherited-from-13]

`OIDCUserConfig.redirectProxyUrl`

#### Defined in [#defined-in-14]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:161

***

### scope? [#scope]

> `optional` **scope**: `string`

Space-separated scopes. Default `openid profile email`. Add `wallet` and `org`.

#### Defined in [#defined-in-15]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:43](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-js/src/index.ts#L43)

***

### style? [#style]

> `optional` **style**: `OAuthProviderButtonStyles`

#### Inherited from [#inherited-from-14]

`OIDCUserConfig.style`

#### Defined in [#defined-in-16]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:146

***

### token? [#token]

> `optional` **token**: `any`

#### Inherited from [#inherited-from-15]

`OIDCUserConfig.token`

#### Defined in [#defined-in-17]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:78

***

### userinfo? [#userinfo]

> `optional` **userinfo**: `any`

#### Inherited from [#inherited-from-16]

`OIDCUserConfig.userinfo`

#### Defined in [#defined-in-18]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:79

***

### wellKnown? [#wellknown]

> `optional` **wellKnown**: `string`

OpenID Connect (OIDC) compliant providers can configure
this instead of `authorize`/`token`/`userinfo` options
without further configuration needed in most cases.
You can still use the `authorize`/`token`/`userinfo`
options for advanced control.

[Authorization Server Metadata](https://datatracker.ietf.org/doc/html/rfc8414#section-3)

#### Inherited from [#inherited-from-17]

`OIDCUserConfig.wellKnown`

#### Defined in [#defined-in-19]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@auth/core/providers/oauth.d.ts:70

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-js/src](../README.md) / AlternateCloudsProfile

# Type Alias: AlternateCloudsProfile [#type-alias-alternatecloudsprofile]

> **AlternateCloudsProfile**: [`IdTokenClaims`](../../../ac-auth/src/interfaces/IdTokenClaims.md)

The claims the issuer puts in the ID token and the userinfo answer.

## Defined in [#defined-in-20]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:37](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-js/src/index.ts#L37)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-js/src](../README.md) / ALTERNATE\_CLOUDS\_PROVIDER\_ID

# Variable: ALTERNATE\_CLOUDS\_PROVIDER\_ID [#variable-alternate_clouds_provider_id]

> `const` **ALTERNATE\_CLOUDS\_PROVIDER\_ID**: `"alternate-clouds"` = `'alternate-clouds'`

## Defined in [#defined-in-21]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:46](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-js/src/index.ts#L46)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-js/src](../README.md) / BRAND\_COLOR

# Variable: BRAND\_COLOR [#variable-brand_color]

> `const` **BRAND\_COLOR**: `"#a5b2ff"` = `'#a5b2ff'`

The brand accent, for the Auth.js default sign-in page button.

## Defined in [#defined-in-22]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:49](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-js/src/index.ts#L49)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../README.md) / ac-auth-next/src

# ac-auth-next/src [#ac-auth-nextsrc]

@alternatefutures/ac-auth-next

Sign in with Alternate Clouds for the Next.js App Router. Create one
instance in `lib/auth.ts` and wire three files:

// lib/auth.ts
export const \{ auth, handlers, signInPath, toClientSession } = createAuth(authConfig);

// app/api/auth/\[...auth]/route.ts
export const \{ GET, POST } = handlers;

// proxy.ts (Next.js 16; middleware.ts on 15)
export const proxy = createAuthProxy(authConfig); // from '@alternatefutures/ac-auth-next/proxy'
export const config = \{ matcher: \[...] }; // a literal: Next.js does not accept an imported constant

Then `await auth()` in Server Components and Route Handlers, and
`<AuthProvider>` from `@alternatefutures/ac-auth-next/react` around the
client tree.

## Index [#index-1]

### Classes [#classes]

* [AcAuthCore](classes/AcAuthCore.md)

### Interfaces [#interfaces-1]

* [AcAuth](interfaces/AcAuth.md)
* [AcAuthConfig](interfaces/AcAuthConfig.md)
* [ClientSession](interfaces/ClientSession.md)
* [ServerSession](interfaces/ServerSession.md)
* [SessionPayload](interfaces/SessionPayload.md)

### Functions [#functions-1]

* [createAuth](functions/createAuth.md)
* [safeReturnTo](functions/safeReturnTo.md)
* [seal](functions/seal.md)
* [unseal](functions/unseal.md)

## References [#references-1]

### AuthProxy [#authproxy]

Re-exports [AuthProxy](proxy/type-aliases/AuthProxy.md)

***

### createAuthProxy [#createauthproxy]

Re-exports [createAuthProxy](proxy/functions/createAuthProxy.md)

***

### PROXY\_MATCHER [#proxy_matcher]

Re-exports [PROXY\_MATCHER](proxy/variables/PROXY_MATCHER.md)

***

### ProxyOptions [#proxyoptions]

Re-exports [ProxyOptions](proxy/interfaces/ProxyOptions.md)

***

### toClientSession [#toclientsession]

Re-exports [toClientSession](interfaces/AcAuth.md#toclientsession)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-next/src](../README.md) / AcAuthCore

# Class: AcAuthCore [#class-acauthcore]

## Constructors [#constructors]

### new AcAuthCore() [#new-acauthcore]

> **new AcAuthCore**(`config`): [`AcAuthCore`](AcAuthCore.md)

#### Parameters [#parameters-3]

• **config**: [`AcAuthConfig`](../interfaces/AcAuthConfig.md) = `{}`

#### Returns [#returns-3]

[`AcAuthCore`](AcAuthCore.md)

#### Defined in [#defined-in-23]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:243](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L243)

## Properties [#properties-1]

### config [#config]

> `readonly` **config**: `ResolvedConfig`

#### Defined in [#defined-in-24]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:237](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L237)

## Methods [#methods]

### clearSessionCookie() [#clearsessioncookie]

> **clearSessionCookie**(`request`): `string`

#### Parameters [#parameters-4]

• **request**: `Request`

#### Returns [#returns-4]

`string`

#### Defined in [#defined-in-25]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:313](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L313)

***

### handle() [#handle]

> **handle**(`request`): `Promise`\<`Response`>

Route a request under `basePath` to the handler for its last segment.

#### Parameters [#parameters-5]

• **request**: `Request`

#### Returns [#returns-5]

`Promise`\<`Response`>

#### Defined in [#defined-in-26]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:573](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L573)

***

### handleCallback() [#handlecallback]

> **handleCallback**(`request`): `Promise`\<`Response`>

`GET <basePath>/callback`: finish the flow, seal the session, go to `returnTo`.

#### Parameters [#parameters-6]

• **request**: `Request`

#### Returns [#returns-6]

`Promise`\<`Response`>

#### Defined in [#defined-in-27]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:406](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L406)

***

### handleSession() [#handlesession]

> **handleSession**(`request`): `Promise`\<`Response`>

`GET <basePath>/session`: the client-safe session.

#### Parameters [#parameters-7]

• **request**: `Request`

#### Returns [#returns-7]

`Promise`\<`Response`>

#### Defined in [#defined-in-28]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:564](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L564)

***

### handleSignIn() [#handlesignin]

> **handleSignIn**(`request`): `Promise`\<`Response`>

`GET <basePath>/signin`: start the code + PKCE flow.

#### Parameters [#parameters-8]

• **request**: `Request`

#### Returns [#returns-8]

`Promise`\<`Response`>

#### Defined in [#defined-in-29]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:369](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L369)

***

### handleSignOut() [#handlesignout]

> **handleSignOut**(`request`): `Promise`\<`Response`>

`POST <basePath>/signout` (also GET): clear the session, optionally end it at the issuer.

#### Parameters [#parameters-9]

• **request**: `Request`

#### Returns [#returns-9]

`Promise`\<`Response`>

#### Defined in [#defined-in-30]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:522](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L522)

***

### metadata() [#metadata]

> **metadata**(): `Promise`\<[`IssuerMetadata`](../../../ac-auth/src/interfaces/IssuerMetadata.md)>

#### Returns [#returns-10]

`Promise`\<[`IssuerMetadata`](../../../ac-auth/src/interfaces/IssuerMetadata.md)>

#### Defined in [#defined-in-31]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:260](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L260)

***

### readSessionCookie() [#readsessioncookie]

> **readSessionCookie**(`cookieHeader`): `null` | `string`

The session cookie value of a request, whichever prefix it was set with.

#### Parameters [#parameters-10]

• **cookieHeader**: `undefined` | `null` | `string`

#### Returns [#returns-11]

`null` | `string`

#### Defined in [#defined-in-32]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:292](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L292)

***

### refreshSessionCookie() [#refreshsessioncookie]

> **refreshSessionCookie**(`cookieValue`): `Promise`\<`object` | `object` | `object`>

Decide what the proxy should do with the incoming session cookie:
`keep` (valid or no session), `set` (refreshed: write this value),
`clear` (definitively signed out).

#### Parameters [#parameters-11]

• **cookieValue**: `undefined` | `null` | `string`

#### Returns [#returns-12]

`Promise`\<`object` | `object` | `object`>

#### Defined in [#defined-in-33]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:494](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L494)

***

### sealSession() [#sealsession]

> **sealSession**(`payload`): `Promise`\<`string`>

#### Parameters [#parameters-12]

• **payload**: [`SessionPayload`](../interfaces/SessionPayload.md)

#### Returns [#returns-13]

`Promise`\<`string`>

#### Defined in [#defined-in-34]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:300](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L300)

***

### sessionCookie() [#sessioncookie]

> **sessionCookie**(`request`, `value`): `string`

#### Parameters [#parameters-13]

• **request**: `Request`

• **value**: `string`

#### Returns [#returns-14]

`string`

#### Defined in [#defined-in-35]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:309](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L309)

***

### sessionCookieName() [#sessioncookiename]

> **sessionCookieName**(`request`): `string`

Cookie names carry a browser-enforced prefix over https (OAuth for
browser-based apps, BFF cookies): `__Host-` for the session cookie
(Secure, Path=/, no Domain, so no subdomain can set or widen it) and
`__Secure-` for the transaction cookie (its path is the base path, which
`__Host-` forbids). Plain names over http (local development).

#### Parameters [#parameters-14]

• **request**: `Request`

#### Returns [#returns-15]

`string`

#### Defined in [#defined-in-36]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:282](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L282)

***

### sessionFromCookieHeader() [#sessionfromcookieheader]

> **sessionFromCookieHeader**(`cookieHeader`): `Promise`\<`null` | [`ServerSession`](../interfaces/ServerSession.md)>

The session carried by a `Cookie` header value.

#### Parameters [#parameters-15]

• **cookieHeader**: `undefined` | `null` | `string`

#### Returns [#returns-16]

`Promise`\<`null` | [`ServerSession`](../interfaces/ServerSession.md)>

#### Defined in [#defined-in-37]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:350](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L350)

***

### sessionFromPayload() [#sessionfrompayload]

> **sessionFromPayload**(`payload`): `null` | [`ServerSession`](../interfaces/ServerSession.md)

Interpret a sealed payload at `now`: null when expired past the grace cap.

#### Parameters [#parameters-16]

• **payload**: `null` | [`SessionPayload`](../interfaces/SessionPayload.md)

#### Returns [#returns-17]

`null` | [`ServerSession`](../interfaces/ServerSession.md)

#### Defined in [#defined-in-38]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:326](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L326)

***

### signInPath() [#signinpath]

> **signInPath**(`returnTo`?, `extra`?): `string`

#### Parameters [#parameters-17]

• &#x2A;*returnTo?**: `null` | `string`

• &#x2A;*extra?**: `Record`\<`string`, `string`> = `{}`

#### Returns [#returns-18]

`string`

#### Defined in [#defined-in-39]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:356](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L356)

***

### signOutPath() [#signoutpath]

> **signOutPath**(): `string`

#### Returns [#returns-19]

`string`

#### Defined in [#defined-in-40]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:364](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L364)

***

### unsealSession() [#unsealsession]

> **unsealSession**(`value`): `Promise`\<`null` | [`SessionPayload`](../interfaces/SessionPayload.md)>

#### Parameters [#parameters-18]

• **value**: `undefined` | `null` | `string`

#### Returns [#returns-20]

`Promise`\<`null` | [`SessionPayload`](../interfaces/SessionPayload.md)>

#### Defined in [#defined-in-41]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:305](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L305)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-next/src](../README.md) / createAuth

# Function: createAuth() [#function-createauth]

> **createAuth**(`config`): [`AcAuth`](../interfaces/AcAuth.md)

## Parameters [#parameters-19]

• **config**: [`AcAuthConfig`](../interfaces/AcAuthConfig.md) = `{}`

## Returns [#returns-21]

[`AcAuth`](../interfaces/AcAuth.md)

## Defined in [#defined-in-42]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:50](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/index.ts#L50)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-next/src](../README.md) / safeReturnTo

# Function: safeReturnTo() [#function-safereturnto]

> **safeReturnTo**(`value`): `string` | `null`

Only same-origin paths may be used as a return target.

## Parameters [#parameters-20]

• **value**: `undefined` | `null` | `string`

## Returns [#returns-22]

`string` | `null`

## Defined in [#defined-in-43]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:217](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L217)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-next/src](../README.md) / seal

# Function: seal() [#function-seal]

> **seal**(`payload`, `options`): `Promise`\<`string`>

## Parameters [#parameters-21]

• **payload**: `Record`\<`string`, `unknown`>

• **options**: `SealOptions`

## Returns [#returns-23]

`Promise`\<`string`>

## Defined in [#defined-in-44]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/seal.ts:41](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/seal.ts#L41)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-next/src](../README.md) / unseal

# Function: unseal() [#function-unseal]

> **unseal**\<`T`>(`token`, `options`): `Promise`\<`T` | `null`>

Null for anything that does not decrypt, is of another purpose, or is expired.

## Type Parameters [#type-parameters]

• **T** *extends* `Record`\<`string`, `unknown`>

## Parameters [#parameters-22]

• **token**: `undefined` | `null` | `string`

• **options**: `Omit`\<`SealOptions`, `"expiresAt"`>

## Returns [#returns-24]

`Promise`\<`T` | `null`>

## Defined in [#defined-in-45]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/seal.ts:52](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/seal.ts#L52)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-next/src](../README.md) / AcAuth

# Interface: AcAuth [#interface-acauth]

## Properties [#properties-2]

### core [#core]

> **core**: [`AcAuthCore`](../classes/AcAuthCore.md)

#### Defined in [#defined-in-46]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:35](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/index.ts#L35)

***

### handlers [#handlers]

> **handlers**: `object`

Route handlers for `app/<basePath>/[...auth]/route.ts`.

#### GET() [#get]

> **GET**: (`request`) => `Promise`\<`Response`>

##### Parameters [#parameters-23]

• **request**: `Request`

##### Returns [#returns-25]

`Promise`\<`Response`>

#### POST() [#post]

> **POST**: (`request`) => `Promise`\<`Response`>

##### Parameters [#parameters-24]

• **request**: `Request`

##### Returns [#returns-26]

`Promise`\<`Response`>

#### Defined in [#defined-in-47]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:39](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/index.ts#L39)

***

### proxy [#proxy]

> **proxy**: [`AuthProxy`](../proxy/type-aliases/AuthProxy.md)

The proxy that refreshes the session cookie, sharing this instance's refresh coordinator.

#### Defined in [#defined-in-48]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:41](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/index.ts#L41)

***

### toClientSession() [#toclientsession-1]

> **toClientSession**: (`session`) => [`ClientSession`](ClientSession.md) | `null`

#### Parameters [#parameters-25]

• **session**: `null` | [`ServerSession`](ServerSession.md)

#### Returns [#returns-27]

[`ClientSession`](ClientSession.md) | `null`

#### Defined in [#defined-in-49]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:47](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/index.ts#L47)

## Methods [#methods-1]

### auth() [#auth]

> **auth**(): `Promise`\<`null` | [`ServerSession`](ServerSession.md)>

The session for the current request (Server Components, Server Actions, Route Handlers). Never refreshes.

#### Returns [#returns-28]

`Promise`\<`null` | [`ServerSession`](ServerSession.md)>

#### Defined in [#defined-in-50]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:37](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/index.ts#L37)

***

### createProxy() [#createproxy]

> **createProxy**(`options`?): [`AuthProxy`](../proxy/type-aliases/AuthProxy.md)

Build a proxy with options (protected paths).

#### Parameters [#parameters-26]

• &#x2A;*options?**: [`ProxyOptions`](../proxy/interfaces/ProxyOptions.md)

#### Returns [#returns-29]

[`AuthProxy`](../proxy/type-aliases/AuthProxy.md)

#### Defined in [#defined-in-51]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:43](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/index.ts#L43)

***

### signInPath() [#signinpath-1]

> **signInPath**(`returnTo`?): `string`

`<basePath>/signin?returnTo=...`

#### Parameters [#parameters-27]

• &#x2A;*returnTo?**: `null` | `string`

#### Returns [#returns-30]

`string`

#### Defined in [#defined-in-52]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:45](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/index.ts#L45)

***

### signOutPath() [#signoutpath-1]

> **signOutPath**(): `string`

#### Returns [#returns-31]

`string`

#### Defined in [#defined-in-53]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:46](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/index.ts#L46)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-next/src](../README.md) / AcAuthConfig

# Interface: AcAuthConfig [#interface-acauthconfig]

## Properties [#properties-3]

### afterSignOutPath? [#aftersignoutpath]

> `optional` **afterSignOutPath**: `string`

Same-origin path to land on after a local sign-out. Default `/`.

#### Defined in [#defined-in-54]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:79](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L79)

***

### basePath? [#basepath]

> `optional` **basePath**: `string`

Where the route handlers are mounted. Default `/api/auth`.

#### Defined in [#defined-in-55]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:71](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L71)

***

### clientAuthenticationMethod? [#clientauthenticationmethod]

> `optional` **clientAuthenticationMethod**: `"client_secret_basic"` | `"client_secret_post"`

How the secret is sent. Default `client_secret_basic` (the issuer's default for new clients).

#### Defined in [#defined-in-56]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:67](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L67)

***

### clientId? [#clientid-1]

> `optional` **clientId**: `string`

Default `ALTERNATE_CLOUDS_CLIENT_ID`.

#### Defined in [#defined-in-57]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:63](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L63)

***

### clientSecret? [#clientsecret-1]

> `optional` **clientSecret**: `string`

Confidential clients only. Default `ALTERNATE_CLOUDS_CLIENT_SECRET`. Absent means a public client (PKCE only).

#### Defined in [#defined-in-58]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:65](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L65)

***

### cookie? [#cookie]

> `optional` **cookie**: `object`

#### domain? [#domain]

> `optional` **domain**: `string`

#### maxAgeSeconds? [#maxageseconds]

> `optional` **maxAgeSeconds**: `number`

Session cookie lifetime. Default 30 days (the refresh token's lifetime).

#### name? [#name-1]

> `optional` **name**: `string`

Default `ac_auth.session`; the transaction cookie is `<name>.txn`.

#### sameSite? [#samesite]

> `optional` **sameSite**: `"lax"` | `"strict"`

#### secure? [#secure]

> `optional` **secure**: `boolean`

Default: secure when the request is https.

#### Defined in [#defined-in-59]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:82](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L82)

***

### embeddedKeys? [#embeddedkeys]

> `optional` **embeddedKeys**: readonly [`JWK`](../../../ac-auth/src/type-aliases/JWK.md)\[]

#### Defined in [#defined-in-60]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:93](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L93)

***

### env? [#env]

> `optional` **env**: `Record`\<`string`, `undefined` | `string`>

#### Defined in [#defined-in-61]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:102](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L102)

***

### fetch? [#fetch]

> `optional` **fetch**: [`FetchLike`](../../../ac-auth/src/type-aliases/FetchLike.md)

#### Defined in [#defined-in-62]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:95](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L95)

***

### grace? [#grace]

> `optional` **grace**: `false` | `Partial`\<[`SessionGracePolicy`](../../../ac-auth/src/interfaces/SessionGracePolicy.md)>

#### Defined in [#defined-in-63]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:92](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L92)

***

### issuer? [#issuer-1]

> `optional` **issuer**: `string`

Issuer identifier. Default `ALTERNATE_CLOUDS_ISSUER`, else the production issuer.

#### Defined in [#defined-in-64]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:61](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L61)

***

### metadata? [#metadata-1]

> `optional` **metadata**: [`IssuerMetadata`](../../../ac-auth/src/interfaces/IssuerMetadata.md)

#### Defined in [#defined-in-65]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:94](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L94)

***

### now()? [#now]

> `optional` **now**: () => `number`

#### Returns [#returns-32]

`number`

#### Defined in [#defined-in-66]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:100](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L100)

***

### onWarning()? [#onwarning]

> `optional` **onWarning**: (`message`, `cause`?) => `void`

#### Parameters [#parameters-28]

• **message**: `string`

• &#x2A;*cause?**: `unknown`

#### Returns [#returns-33]

`void`

#### Defined in [#defined-in-67]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:101](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L101)

***

### postLogoutRedirectUri? [#postlogoutredirecturi]

> `optional` **postLogoutRedirectUri**: `string`

Registered post-logout redirect URI. When set, sign-out also ends the issuer session.

#### Defined in [#defined-in-68]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:77](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L77)

***

### redirectUri? [#redirecturi]

> `optional` **redirectUri**: `string`

Absolute redirect URI registered on the client. Default `<origin><basePath>/callback` of the incoming request.

#### Defined in [#defined-in-69]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:75](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L75)

***

### refreshLeewayMs? [#refreshleewayms]

> `optional` **refreshLeewayMs**: `number`

Refresh this long before the access token expires. Default 30 s.

#### Defined in [#defined-in-70]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:97](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L97)

***

### revokeOnSignOut? [#revokeonsignout]

> `optional` **revokeOnSignOut**: `boolean`

Also revoke the refresh token at the issuer on sign-out (disconnects the app on every device). Default false.

#### Defined in [#defined-in-71]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:81](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L81)

***

### scope? [#scope-1]

> `optional` **scope**: `string` | readonly `string`\[]

Default `openid profile email`.

#### Defined in [#defined-in-72]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:73](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L73)

***

### secret? [#secret]

> `optional` **secret**: `string`

Seals the cookies. Default `AUTH_SECRET`. At least 16 characters.

#### Defined in [#defined-in-73]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:69](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L69)

***

### trustHost? [#trusthost]

> `optional` **trustHost**: `boolean`

Trust `x-forwarded-proto` / `x-forwarded-host` to compute the origin. Default true.

#### Defined in [#defined-in-74]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:99](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L99)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-next/src](../README.md) / ClientSession

# Interface: ClientSession [#interface-clientsession]

What the browser is allowed to see.

## Properties [#properties-4]

### expiresAt [#expiresat]

> **expiresAt**: `number`

#### Defined in [#defined-in-75]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:169](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L169)

***

### issuedAt [#issuedat]

> **issuedAt**: `number`

#### Defined in [#defined-in-76]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:170](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L170)

***

### status [#status]

> **status**: `"active"` | `"grace"`

#### Defined in [#defined-in-77]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:167](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L167)

***

### user [#user]

> **user**: [`AuthUser`](../../../ac-auth/src/interfaces/AuthUser.md)

#### Defined in [#defined-in-78]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:168](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L168)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-next/src](../README.md) / ServerSession

# Interface: ServerSession [#interface-serversession]

What `auth()` returns on the server.

## Properties [#properties-5]

### accessToken [#accesstoken]

> **accessToken**: `string`

#### Defined in [#defined-in-79]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:160](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L160)

***

### claims [#claims]

> **claims**: [`IdTokenClaims`](../../../ac-auth/src/interfaces/IdTokenClaims.md)

#### Defined in [#defined-in-80]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:156](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L156)

***

### expiresAt [#expiresat-1]

> **expiresAt**: `number`

Epoch ms.

#### Defined in [#defined-in-81]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:158](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L158)

***

### idToken [#idtoken-1]

> **idToken**: `null` | `string`

#### Defined in [#defined-in-82]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:161](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L161)

***

### issuedAt [#issuedat-1]

> **issuedAt**: `number`

#### Defined in [#defined-in-83]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:159](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L159)

***

### scope [#scope-2]

> **scope**: `null` | `string`

#### Defined in [#defined-in-84]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:162](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L162)

***

### status [#status-1]

> **status**: `"active"` | `"grace"`

#### Defined in [#defined-in-85]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:154](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L154)

***

### user [#user-1]

> **user**: [`AuthUser`](../../../ac-auth/src/interfaces/AuthUser.md)

#### Defined in [#defined-in-86]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:155](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L155)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-next/src](../README.md) / SessionPayload

# Interface: SessionPayload [#interface-sessionpayload]

The sealed session cookie.

## Extends [#extends-1]

* `Record`\<`string`, `unknown`>

## Properties [#properties-6]

### at [#at]

> **at**: `string`

#### Defined in [#defined-in-87]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:133](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L133)

***

### exp\_ms [#exp_ms]

> **exp\_ms**: `number`

Access token expiry, epoch ms.

#### Defined in [#defined-in-88]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:137](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L137)

***

### iat\_ms [#iat_ms]

> **iat\_ms**: `number`

Issued at, epoch ms.

#### Defined in [#defined-in-89]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:139](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L139)

***

### idt [#idt]

> **idt**: `null` | `string`

#### Defined in [#defined-in-90]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:135](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L135)

***

### rt [#rt]

> **rt**: `null` | `string`

#### Defined in [#defined-in-91]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:134](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L134)

***

### scope [#scope-3]

> **scope**: `null` | `string`

#### Defined in [#defined-in-92]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:140](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L140)

***

### v [#v]

> **v**: `1`

#### Defined in [#defined-in-93]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:132](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/core.ts#L132)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / ac-auth-next/src/proxy

# ac-auth-next/src/proxy [#ac-auth-nextsrcproxy]

## Index [#index-2]

### Interfaces [#interfaces-2]

* [ProxyOptions](interfaces/ProxyOptions.md)

### Type Aliases [#type-aliases-1]

* [AuthProxy](type-aliases/AuthProxy.md)

### Variables [#variables-1]

* [PROXY\_MATCHER](variables/PROXY_MATCHER.md)

### Functions [#functions-2]

* [createAuthProxy](functions/createAuthProxy.md)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../../README.md) / [ac-auth-next/src/proxy](../README.md) / createAuthProxy

# Function: createAuthProxy() [#function-createauthproxy]

> **createAuthProxy**(`configOrCore`, `options`): [`AuthProxy`](../type-aliases/AuthProxy.md)

Build the proxy from an existing core (shared with `createAuth`) or a config.

## Parameters [#parameters-29]

• **configOrCore**: [`AcAuthConfig`](../../interfaces/AcAuthConfig.md) | [`AcAuthCore`](../../classes/AcAuthCore.md) = `{}`

• **options**: [`ProxyOptions`](../interfaces/ProxyOptions.md) = `{}`

## Returns [#returns-34]

[`AuthProxy`](../type-aliases/AuthProxy.md)

## Defined in [#defined-in-94]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/proxy.ts:39](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/proxy.ts#L39)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../../README.md) / [ac-auth-next/src/proxy](../README.md) / ProxyOptions

# Interface: ProxyOptions [#interface-proxyoptions]

## Properties [#properties-7]

### protect? [#protect]

> `optional` **protect**: `string`\[] | (`pathname`) => `boolean`

Paths (or a predicate) that require a session. A visitor without one is
sent to the sign-in with `returnTo` set. Default: nothing is protected;
pages decide with `auth()`.

#### Defined in [#defined-in-95]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/proxy.ts:24](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/proxy.ts#L24)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../../README.md) / [ac-auth-next/src/proxy](../README.md) / AuthProxy

# Type Alias: AuthProxy() [#type-alias-authproxy]

> **AuthProxy**: (`request`) => `Promise`\<`NextResponse`>

## Parameters [#parameters-30]

• **request**: `NextRequest`

## Returns [#returns-35]

`Promise`\<`NextResponse`>

## Defined in [#defined-in-96]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/proxy.ts:30](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/proxy.ts#L30)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../../README.md) / [ac-auth-next/src/proxy](../README.md) / PROXY\_MATCHER

# Variable: PROXY\_MATCHER [#variable-proxy_matcher]

> `const` **PROXY\_MATCHER**: `string`\[]

The recommended matcher (skips static assets). Copy its VALUE into `proxy.ts`: Next.js only accepts a literal there.

## Defined in [#defined-in-97]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/proxy.ts:28](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/proxy.ts#L28)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / ac-auth-next/src/react

# ac-auth-next/src/react [#ac-auth-nextsrcreact]

## Index [#index-3]

### Interfaces [#interfaces-3]

* [AuthProviderProps](interfaces/AuthProviderProps.md)

### Functions [#functions-3]

* [AuthProvider](functions/AuthProvider.md)
* [serverAdapter](functions/serverAdapter.md)

## References [#references-2]

### AuthSession [#authsession]

Re-exports [AuthSession](../../../ac-auth-react/src/interfaces/AuthSession.md)

***

### AuthSignInOptions [#authsigninoptions]

Re-exports [AuthSignInOptions](../../../ac-auth-react/src/interfaces/AuthSignInOptions.md)

***

### AuthSignOutOptions [#authsignoutoptions]

Re-exports [AuthSignOutOptions](../../../ac-auth-react/src/interfaces/AuthSignOutOptions.md)

***

### AuthStatus [#authstatus]

Re-exports [AuthStatus](../../../ac-auth-react/src/type-aliases/AuthStatus.md)

***

### AuthTheme [#auththeme]

Re-exports [AuthTheme](../../../ac-auth-react/src/type-aliases/AuthTheme.md)

***

### Mark [#mark]

Re-exports [Mark](../../../ac-auth-react/src/functions/Mark.md)

***

### SIGN\_IN\_LABEL [#sign_in_label]

Re-exports [SIGN\_IN\_LABEL](../../../ac-auth-react/src/variables/SIGN_IN_LABEL.md)

***

### SignedIn [#signedin]

Re-exports [SignedIn](../../../ac-auth-react/src/functions/SignedIn.md)

***

### SignedOut [#signedout]

Re-exports [SignedOut](../../../ac-auth-react/src/functions/SignedOut.md)

***

### SignedProps [#signedprops]

Re-exports [SignedProps](../../../ac-auth-react/src/interfaces/SignedProps.md)

***

### SignIn [#signin]

Re-exports [SignIn](../../../ac-auth-react/src/functions/SignIn.md)

***

### SignInButton [#signinbutton]

Re-exports [SignInButton](../../../ac-auth-react/src/functions/SignInButton.md)

***

### SignInButtonProps [#signinbuttonprops]

Re-exports [SignInButtonProps](../../../ac-auth-react/src/interfaces/SignInButtonProps.md)

***

### SignInMethod [#signinmethod]

Re-exports [SignInMethod](../../../ac-auth-react/src/type-aliases/SignInMethod.md)

***

### SignInProps [#signinprops]

Re-exports [SignInProps](../../../ac-auth-react/src/interfaces/SignInProps.md)

***

### useAuth [#useauth]

Re-exports [useAuth](../../../ac-auth-react/src/functions/useAuth.md)

***

### useOrganization [#useorganization]

Re-exports [useOrganization](../../../ac-auth-react/src/functions/useOrganization.md)

***

### UserButton [#userbutton]

Re-exports [UserButton](../../../ac-auth-react/src/functions/UserButton.md)

***

### UserButtonItem [#userbuttonitem]

Re-exports [UserButtonItem](../../../ac-auth-react/src/functions/UserButtonItem.md)

***

### UserButtonItemProps [#userbuttonitemprops]

Re-exports [UserButtonItemProps](../../../ac-auth-react/src/interfaces/UserButtonItemProps.md)

***

### UserButtonProps [#userbuttonprops]

Re-exports [UserButtonProps](../../../ac-auth-react/src/interfaces/UserButtonProps.md)

***

### useSession [#usesession]

Re-exports [useSession](../../../ac-auth-react/src/functions/useSession.md)

***

### useUser [#useuser]

Re-exports [useUser](../../../ac-auth-react/src/functions/useUser.md)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../../README.md) / [ac-auth-next/src/react](../README.md) / AuthProvider

# Function: AuthProvider() [#function-authprovider]

> **AuthProvider**(`__namedParameters`): `Element`

## Parameters [#parameters-31]

• **\_\_namedParameters**: [`AuthProviderProps`](../interfaces/AuthProviderProps.md)

## Returns [#returns-36]

`Element`

## Defined in [#defined-in-98]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/react.tsx:98](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/react.tsx#L98)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../../README.md) / [ac-auth-next/src/react](../README.md) / serverAdapter

# Function: serverAdapter() [#function-serveradapter]

> **serverAdapter**(`basePath`): [`AuthAdapter`](../../../../ac-auth-react/src/interfaces/AuthAdapter.md)

Adapter over the route handlers.

## Parameters [#parameters-32]

• **basePath**: `string` = `'/api/auth'`

## Returns [#returns-37]

[`AuthAdapter`](../../../../ac-auth-react/src/interfaces/AuthAdapter.md)

## Defined in [#defined-in-99]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/react.tsx:56](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/react.tsx#L56)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../../README.md) / [ac-auth-next/src/react](../README.md) / AuthProviderProps

# Interface: AuthProviderProps [#interface-authproviderprops]

## Extends [#extends-2]

* `Omit`\<[`AuthProviderProps`](../../../../ac-auth-react/src/interfaces/AuthProviderProps.md), `"client"` | `"adapter"`>

## Properties [#properties-8]

### basePath? [#basepath-1]

> `optional` **basePath**: `string`

Must match `createAuth({ basePath })`. Default `/api/auth`.

#### Defined in [#defined-in-100]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/react.tsx:48](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/react.tsx#L48)

***

### children? [#children]

> `optional` **children**: `ReactNode`

#### Inherited from [#inherited-from-18]

`Omit.children`

#### Defined in [#defined-in-101]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:95](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L95)

***

### initialSession? [#initialsession]

> `optional` **initialSession**: `null` | [`AuthSession`](../../../../ac-auth-react/src/interfaces/AuthSession.md)

From `toClientSession(await auth())` in a Server Component, so the first paint is right.

#### Overrides [#overrides-1]

`Omit.initialSession`

#### Defined in [#defined-in-102]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/react.tsx:50](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-next/src/react.tsx#L50)

***

### onError()? [#onerror]

> `optional` **onError**: (`error`) => `void`

#### Parameters [#parameters-33]

• **error**: `Error`

#### Returns [#returns-38]

`void`

#### Inherited from [#inherited-from-19]

`Omit.onError`

#### Defined in [#defined-in-103]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:94](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L94)

***

### onSignedIn()? [#onsignedin]

> `optional` **onSignedIn**: (`returnTo`, `session`) => `void`

Client mode: called with the path to continue on after a sign-in completed on this page. Default: `history.replaceState`.

#### Parameters [#parameters-34]

• **returnTo**: `null` | `string`

• **session**: [`AuthSession`](../../../../ac-auth-react/src/interfaces/AuthSession.md)

#### Returns [#returns-39]

`void`

#### Inherited from [#inherited-from-20]

`Omit.onSignedIn`

#### Defined in [#defined-in-104]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:93](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L93)

***

### theme? [#theme]

> `optional` **theme**: [`AuthTheme`](../../../../ac-auth-react/src/type-aliases/AuthTheme.md)

`dark` (default, the Alternate Clouds web app's scheme) or `light` force a
scheme, `system` follows the OS, `inherit` sets no variables so the host's
own design tokens apply (an app running the web app's stylesheet).

#### Inherited from [#inherited-from-21]

`Omit.theme`

#### Defined in [#defined-in-105]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:91](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L91)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../README.md) / ac-auth-react/src

# ac-auth-react/src [#ac-auth-reactsrc]

@alternatefutures/ac-auth-react

React components and hooks for Sign in with Alternate Clouds, built from
the same shadcn primitives, palette and typography as the Alternate Clouds
web app. Import the stylesheet once (`@alternatefutures/ac-auth-react/styles.css`)
unless the app already runs the web app's stylesheet (then pass
theme="inherit"), wrap the app in `<AuthProvider>`, and use the components.

## Index [#index-4]

### Interfaces [#interfaces-4]

* [AuthAdapter](interfaces/AuthAdapter.md)
* [AuthContextValue](interfaces/AuthContextValue.md)
* [AuthProviderProps](interfaces/AuthProviderProps.md)
* [AuthSession](interfaces/AuthSession.md)
* [AuthSignInOptions](interfaces/AuthSignInOptions.md)
* [AuthSignOutOptions](interfaces/AuthSignOutOptions.md)
* [MarkProps](interfaces/MarkProps.md)
* [SignedProps](interfaces/SignedProps.md)
* [SignInButtonProps](interfaces/SignInButtonProps.md)
* [SignInProps](interfaces/SignInProps.md)
* [UserButtonItemProps](interfaces/UserButtonItemProps.md)
* [UserButtonProps](interfaces/UserButtonProps.md)

### Type Aliases [#type-aliases-2]

* [AuthStatus](type-aliases/AuthStatus.md)
* [AuthTheme](type-aliases/AuthTheme.md)
* [SignInMethod](type-aliases/SignInMethod.md)

### Variables [#variables-2]

* [AUTH\_CARD\_CLASS](variables/AUTH_CARD_CLASS.md)
* [BRAND\_BUTTON\_CLASS](variables/BRAND_BUTTON_CLASS.md)
* [DEFAULT\_ACCOUNT\_URL](variables/DEFAULT_ACCOUNT_URL.md)
* [SIGN\_IN\_LABEL](variables/SIGN_IN_LABEL.md)

### Functions [#functions-4]

* [AuthProvider](functions/AuthProvider.md)
* [clientAdapter](functions/clientAdapter.md)
* [Mark](functions/Mark.md)
* [SignedIn](functions/SignedIn.md)
* [SignedOut](functions/SignedOut.md)
* [SignIn](functions/SignIn.md)
* [SignInButton](functions/SignInButton.md)
* [useAuth](functions/useAuth.md)
* [useOrganization](functions/useOrganization.md)
* [UserButton](functions/UserButton.md)
* [UserButtonItem](functions/UserButtonItem.md)
* [useSession](functions/useSession.md)
* [useUser](functions/useUser.md)

## References [#references-3]

### AuthUser [#authuser]

Re-exports [AuthUser](../../ac-auth/src/interfaces/AuthUser.md)

***

### OrganizationClaim [#organizationclaim]

Re-exports [OrganizationClaim](../../ac-auth/src/interfaces/OrganizationClaim.md)

***

### Session [#session]

Re-exports [Session](../../ac-auth/src/interfaces/Session.md)

***

### TokenSet [#tokenset]

Re-exports [TokenSet](../../ac-auth/src/interfaces/TokenSet.md)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / AuthProvider

# Function: AuthProvider() [#function-authprovider-1]

> **AuthProvider**(`props`): `Element`

## Parameters [#parameters-35]

• **props**: [`AuthProviderProps`](../interfaces/AuthProviderProps.md)

## Returns [#returns-40]

`Element`

## Defined in [#defined-in-106]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:127](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L127)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / Mark

# Function: Mark() [#function-mark]

> **Mark**(`__namedParameters`): `Element`

## Parameters [#parameters-36]

• **\_\_namedParameters**: [`MarkProps`](../interfaces/MarkProps.md)

## Returns [#returns-41]

`Element`

## Defined in [#defined-in-107]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/Mark.tsx:15](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/Mark.tsx#L15)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / SignIn

# Function: SignIn() [#function-signin]

> **SignIn**(`__namedParameters`): `Element`

## Parameters [#parameters-37]

• **\_\_namedParameters**: [`SignInProps`](../interfaces/SignInProps.md)

## Returns [#returns-42]

`Element`

## Defined in [#defined-in-108]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:58](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L58)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / SignInButton

# Function: SignInButton() [#function-signinbutton]

> **SignInButton**(`__namedParameters`): `Element`

## Parameters [#parameters-38]

• **\_\_namedParameters**: [`SignInButtonProps`](../interfaces/SignInButtonProps.md)

## Returns [#returns-43]

`Element`

## Defined in [#defined-in-109]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignInButton.tsx:36](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignInButton.tsx#L36)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / SignedIn

# Function: SignedIn() [#function-signedin]

> **SignedIn**(`__namedParameters`): `null` | `Element`

Renders its children only for a signed-in user.

## Parameters [#parameters-39]

• **\_\_namedParameters**: [`SignedProps`](../interfaces/SignedProps.md)

## Returns [#returns-44]

`null` | `Element`

## Defined in [#defined-in-110]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/Signed.tsx:13](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/Signed.tsx#L13)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / SignedOut

# Function: SignedOut() [#function-signedout]

> **SignedOut**(`__namedParameters`): `null` | `Element`

Renders its children only when nobody is signed in.

## Parameters [#parameters-40]

• **\_\_namedParameters**: [`SignedProps`](../interfaces/SignedProps.md)

## Returns [#returns-45]

`null` | `Element`

## Defined in [#defined-in-111]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/Signed.tsx:20](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/Signed.tsx#L20)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / UserButton

# Function: UserButton() [#function-userbutton]

> **UserButton**(`__namedParameters`): `null` | `Element`

## Parameters [#parameters-41]

• **\_\_namedParameters**: [`UserButtonProps`](../interfaces/UserButtonProps.md)

## Returns [#returns-46]

`null` | `Element`

## Defined in [#defined-in-112]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:58](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L58)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / UserButtonItem

# Function: UserButtonItem() [#function-userbuttonitem]

> **UserButtonItem**(`__namedParameters`): `Element`

A menu item for `<UserButton>`: a link when `href` is given, else a button.

## Parameters [#parameters-42]

• **\_\_namedParameters**: [`UserButtonItemProps`](../interfaces/UserButtonItemProps.md)

## Returns [#returns-47]

`Element`

## Defined in [#defined-in-113]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:43](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L43)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / clientAdapter

# Function: clientAdapter() [#function-clientadapter]

> **clientAdapter**(`client`): [`AuthAdapter`](../interfaces/AuthAdapter.md)

Wrap an [AuthClient](../../../ac-auth/src/classes/AuthClient.md) as an adapter.

## Parameters [#parameters-43]

• **client**: [`AuthClient`](../../../ac-auth/src/classes/AuthClient.md)

## Returns [#returns-48]

[`AuthAdapter`](../interfaces/AuthAdapter.md)

## Defined in [#defined-in-114]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:104](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L104)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / useAuth

# Function: useAuth() [#function-useauth]

> **useAuth**(): [`AuthContextValue`](../interfaces/AuthContextValue.md)

## Returns [#returns-49]

[`AuthContextValue`](../interfaces/AuthContextValue.md)

## Defined in [#defined-in-115]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:236](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L236)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / useOrganization

# Function: useOrganization() [#function-useorganization]

> **useOrganization**(): `object`

## Returns [#returns-50]

`object`

### isLoaded [#isloaded]

> **isLoaded**: `boolean`

### organization [#organization]

> **organization**: [`OrganizationClaim`](../../../ac-auth/src/interfaces/OrganizationClaim.md) | `null`

### role [#role]

> **role**: `string` | `null`

## Defined in [#defined-in-116]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:252](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L252)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / useSession

# Function: useSession() [#function-usesession]

> **useSession**(): `object`

## Returns [#returns-51]

`object`

### isLoaded [#isloaded-1]

> **isLoaded**: `boolean`

### refresh() [#refresh]

> **refresh**: () => `Promise`\<[`AuthSession`](../interfaces/AuthSession.md) | `null`>

#### Returns [#returns-52]

`Promise`\<[`AuthSession`](../interfaces/AuthSession.md) | `null`>

### session [#session-1]

> **session**: [`AuthSession`](../interfaces/AuthSession.md) | `null`

### status [#status-2]

> **status**: [`AuthStatus`](../type-aliases/AuthStatus.md)

## Defined in [#defined-in-117]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:247](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L247)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / useUser

# Function: useUser() [#function-useuser]

> **useUser**(): `object`

## Returns [#returns-53]

`object`

### isLoaded [#isloaded-2]

> **isLoaded**: `boolean`

### isSignedIn [#issignedin]

> **isSignedIn**: `boolean`

### user [#user-2]

> **user**: [`AuthUser`](../../../ac-auth/src/interfaces/AuthUser.md) | `null`

## Defined in [#defined-in-118]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:242](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L242)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / AuthAdapter

# Interface: AuthAdapter [#interface-authadapter]

What the provider needs from a session source. Implemented by auth-next for the server-side session.

## Methods [#methods-2]

### completeCallback()? [#completecallback]

> `optional` **completeCallback**(): `Promise`\<`null` | `object`>

Client mode only: finish a sign-in when the current page is the
redirect URI. Returns the path to continue on, or null when the page is
not a callback.

#### Returns [#returns-54]

`Promise`\<`null` | `object`>

#### Defined in [#defined-in-119]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:58](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L58)

***

### getSession() [#getsession]

> **getSession**(): `Promise`\<`null` | [`AuthSession`](AuthSession.md)>

#### Returns [#returns-55]

`Promise`\<`null` | [`AuthSession`](AuthSession.md)>

#### Defined in [#defined-in-120]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:49](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L49)

***

### peek()? [#peek]

> `optional` **peek**(): `null` | [`AuthSession`](AuthSession.md)

Synchronous snapshot for the first render, if the adapter has one.

#### Returns [#returns-56]

`null` | [`AuthSession`](AuthSession.md)

#### Defined in [#defined-in-121]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:48](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L48)

***

### signIn() [#signin-1]

> **signIn**(`options`?): `void` | `Promise`\<`void`>

#### Parameters [#parameters-44]

• &#x2A;*options?**: [`AuthSignInOptions`](AuthSignInOptions.md)

#### Returns [#returns-57]

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

#### Defined in [#defined-in-122]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:50](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L50)

***

### signOut() [#signout]

> **signOut**(`options`?): `void` | `Promise`\<`void`>

#### Parameters [#parameters-45]

• &#x2A;*options?**: [`AuthSignOutOptions`](AuthSignOutOptions.md)

#### Returns [#returns-58]

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

#### Defined in [#defined-in-123]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:51](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L51)

***

### subscribe()? [#subscribe]

> `optional` **subscribe**(`listener`): () => `void`

#### Parameters [#parameters-46]

• **listener**

#### Returns [#returns-59]

`Function`

##### Returns [#returns-60]

`void`

#### Defined in [#defined-in-124]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:52](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L52)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / AuthContextValue

# Interface: AuthContextValue [#interface-authcontextvalue]

## Properties [#properties-9]

### error [#error]

> **error**: `null` | `Error`

#### Defined in [#defined-in-125]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:65](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L65)

***

### isLoaded [#isloaded-3]

> **isLoaded**: `boolean`

#### Defined in [#defined-in-126]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:66](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L66)

***

### isSignedIn [#issignedin-1]

> **isSignedIn**: `boolean`

#### Defined in [#defined-in-127]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:67](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L67)

***

### session [#session-2]

> **session**: `null` | [`AuthSession`](AuthSession.md)

#### Defined in [#defined-in-128]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:63](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L63)

***

### status [#status-3]

> **status**: [`AuthStatus`](../type-aliases/AuthStatus.md)

#### Defined in [#defined-in-129]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:62](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L62)

***

### theme [#theme-1]

> **theme**: [`AuthTheme`](../type-aliases/AuthTheme.md)

#### Defined in [#defined-in-130]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:72](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L72)

***

### user [#user-3]

> **user**: `null` | [`AuthUser`](../../../ac-auth/src/interfaces/AuthUser.md)

#### Defined in [#defined-in-131]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:64](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L64)

## Methods [#methods-3]

### refresh() [#refresh-1]

> **refresh**(): `Promise`\<`null` | [`AuthSession`](AuthSession.md)>

Re-read the session from its source (refreshing tokens when needed).

#### Returns [#returns-61]

`Promise`\<`null` | [`AuthSession`](AuthSession.md)>

#### Defined in [#defined-in-132]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:71](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L71)

***

### signIn() [#signin-2]

> **signIn**(`options`?): `Promise`\<`void`>

#### Parameters [#parameters-47]

• &#x2A;*options?**: [`AuthSignInOptions`](AuthSignInOptions.md)

#### Returns [#returns-62]

`Promise`\<`void`>

#### Defined in [#defined-in-133]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:68](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L68)

***

### signOut() [#signout-1]

> **signOut**(`options`?): `Promise`\<`void`>

#### Parameters [#parameters-48]

• &#x2A;*options?**: [`AuthSignOutOptions`](AuthSignOutOptions.md)

#### Returns [#returns-63]

`Promise`\<`void`>

#### Defined in [#defined-in-134]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:69](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L69)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / AuthProviderProps

# Interface: AuthProviderProps [#interface-authproviderprops-1]

## Properties [#properties-10]

### adapter? [#adapter]

> `optional` **adapter**: [`AuthAdapter`](AuthAdapter.md)

Server-session mode (auth-next) or any custom source.

#### Defined in [#defined-in-135]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:83](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L83)

***

### children? [#children-1]

> `optional` **children**: `ReactNode`

#### Defined in [#defined-in-136]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:95](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L95)

***

### client? [#client-1]

> `optional` **client**: [`AuthClient`](../../../ac-auth/src/classes/AuthClient.md)

Browser-only mode: the client does PKCE and holds the tokens.

#### Defined in [#defined-in-137]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:81](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L81)

***

### initialSession? [#initialsession-1]

> `optional` **initialSession**: `null` | [`AuthSession`](AuthSession.md)

A session known at render time (from the server) so the first paint is right.

#### Defined in [#defined-in-138]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:85](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L85)

***

### onError()? [#onerror-1]

> `optional` **onError**: (`error`) => `void`

#### Parameters [#parameters-49]

• **error**: `Error`

#### Returns [#returns-64]

`void`

#### Defined in [#defined-in-139]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:94](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L94)

***

### onSignedIn()? [#onsignedin-1]

> `optional` **onSignedIn**: (`returnTo`, `session`) => `void`

Client mode: called with the path to continue on after a sign-in completed on this page. Default: `history.replaceState`.

#### Parameters [#parameters-50]

• **returnTo**: `null` | `string`

• **session**: [`AuthSession`](AuthSession.md)

#### Returns [#returns-65]

`void`

#### Defined in [#defined-in-140]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:93](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L93)

***

### theme? [#theme-2]

> `optional` **theme**: [`AuthTheme`](../type-aliases/AuthTheme.md)

`dark` (default, the Alternate Clouds web app's scheme) or `light` force a
scheme, `system` follows the OS, `inherit` sets no variables so the host's
own design tokens apply (an app running the web app's stylesheet).

#### Defined in [#defined-in-141]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:91](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L91)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / AuthSession

# Interface: AuthSession [#interface-authsession]

A session as the React tree sees it. Tokens are present only in client mode.

## Properties [#properties-11]

### expiresAt [#expiresat-2]

> **expiresAt**: `number`

Epoch ms.

#### Defined in [#defined-in-142]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:25](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L25)

***

### issuedAt [#issuedat-2]

> **issuedAt**: `number`

#### Defined in [#defined-in-143]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:26](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L26)

***

### status [#status-4]

> **status**: `"active"` | `"grace"`

#### Defined in [#defined-in-144]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:22](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L22)

***

### tokens? [#tokens]

> `optional` **tokens**: [`TokenSet`](../../../ac-auth/src/interfaces/TokenSet.md)

#### Defined in [#defined-in-145]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:27](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L27)

***

### user [#user-4]

> **user**: [`AuthUser`](../../../ac-auth/src/interfaces/AuthUser.md)

#### Defined in [#defined-in-146]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:23](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L23)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / AuthSignInOptions

# Interface: AuthSignInOptions [#interface-authsigninoptions]

## Extended by [#extended-by]

* [`SignInButtonProps`](SignInButtonProps.md)
* [`SignInProps`](SignInProps.md)

## Properties [#properties-12]

### loginHint? [#loginhint]

> `optional` **loginHint**: `string`

#### Defined in [#defined-in-147]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:37](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L37)

***

### prompt? [#prompt]

> `optional` **prompt**: `"none"` | `"login"` | `"consent"` | `"select_account"`

#### Defined in [#defined-in-148]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:36](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L36)

***

### returnTo? [#returnto]

> `optional` **returnTo**: `string`

Where to land after the sign-in completes. Same-origin path.

#### Defined in [#defined-in-149]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:34](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L34)

***

### scope? [#scope-4]

> `optional` **scope**: `string` | readonly `string`\[]

#### Defined in [#defined-in-150]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:35](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L35)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / AuthSignOutOptions

# Interface: AuthSignOutOptions [#interface-authsignoutoptions]

## Extended by [#extended-by-1]

* [`UserButtonProps`](UserButtonProps.md)

## Properties [#properties-13]

### returnTo? [#returnto-1]

> `optional` **returnTo**: `string`

Where to land after signing out (client mode: the registered post-logout redirect URI is used when set).

#### Defined in [#defined-in-151]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:42](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L42)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / MarkProps

# Interface: MarkProps [#interface-markprops]

## Extends [#extends-3]

* `Omit`\<`React.SVGProps`\<`SVGSVGElement`>, `"children"`>

## Properties [#properties-14]

### accentHeight? [#accentheight]

> `optional` **accentHeight**: `string` | `number`

#### Inherited from [#inherited-from-22]

`Omit.accentHeight`

#### Defined in [#defined-in-152]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3718

***

### accumulate? [#accumulate]

> `optional` **accumulate**: `"none"` | `"sum"`

#### Inherited from [#inherited-from-23]

`Omit.accumulate`

#### Defined in [#defined-in-153]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3719

***

### additive? [#additive]

> `optional` **additive**: `"sum"` | `"replace"`

#### Inherited from [#inherited-from-24]

`Omit.additive`

#### Defined in [#defined-in-154]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3720

***

### alignmentBaseline? [#alignmentbaseline]

> `optional` **alignmentBaseline**: `"inherit"` | `"auto"` | `"alphabetic"` | `"hanging"` | `"ideographic"` | `"mathematical"` | `"baseline"` | `"before-edge"` | `"text-before-edge"` | `"middle"` | `"central"` | `"after-edge"` | `"text-after-edge"`

#### Inherited from [#inherited-from-25]

`Omit.alignmentBaseline`

#### Defined in [#defined-in-155]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3721

***

### allowReorder? [#allowreorder]

> `optional` **allowReorder**: `"yes"` | `"no"`

#### Inherited from [#inherited-from-26]

`Omit.allowReorder`

#### Defined in [#defined-in-156]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3736

***

### alphabetic? [#alphabetic]

> `optional` **alphabetic**: `string` | `number`

#### Inherited from [#inherited-from-27]

`Omit.alphabetic`

#### Defined in [#defined-in-157]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3737

***

### amplitude? [#amplitude]

> `optional` **amplitude**: `string` | `number`

#### Inherited from [#inherited-from-28]

`Omit.amplitude`

#### Defined in [#defined-in-158]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3738

***

### arabicForm? [#arabicform]

> `optional` **arabicForm**: `"initial"` | `"medial"` | `"terminal"` | `"isolated"`

#### Inherited from [#inherited-from-29]

`Omit.arabicForm`

#### Defined in [#defined-in-159]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3739

***

### aria-activedescendant? [#aria-activedescendant]

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from [#inherited-from-30]

`Omit.aria-activedescendant`

#### Defined in [#defined-in-160]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2585

***

### aria-atomic? [#aria-atomic]

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from [#inherited-from-31]

`Omit.aria-atomic`

#### Defined in [#defined-in-161]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2587

***

### aria-autocomplete? [#aria-autocomplete]

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
presented if they are made.

#### Inherited from [#inherited-from-32]

`Omit.aria-autocomplete`

#### Defined in [#defined-in-162]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2592

***

### aria-braillelabel? [#aria-braillelabel]

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See [#see-3]

aria-label.

#### Inherited from [#inherited-from-33]

`Omit.aria-braillelabel`

#### Defined in [#defined-in-163]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2598

***

### aria-brailleroledescription? [#aria-brailleroledescription]

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See [#see-4]

aria-roledescription.

#### Inherited from [#inherited-from-34]

`Omit.aria-brailleroledescription`

#### Defined in [#defined-in-164]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2603

***

### aria-busy? [#aria-busy]

> `optional` **aria-busy**: `Booleanish`

#### Inherited from [#inherited-from-35]

`Omit.aria-busy`

#### Defined in [#defined-in-165]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2604

***

### aria-checked? [#aria-checked]

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See [#see-5]

* aria-pressed
* aria-selected.

#### Inherited from [#inherited-from-36]

`Omit.aria-checked`

#### Defined in [#defined-in-166]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2609

***

### aria-colcount? [#aria-colcount]

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See [#see-6]

aria-colindex.

#### Inherited from [#inherited-from-37]

`Omit.aria-colcount`

#### Defined in [#defined-in-167]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2614

***

### aria-colindex? [#aria-colindex]

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See [#see-7]

* aria-colcount
* aria-colspan.

#### Inherited from [#inherited-from-38]

`Omit.aria-colindex`

#### Defined in [#defined-in-168]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2619

***

### aria-colindextext? [#aria-colindextext]

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See [#see-8]

aria-rowindextext.

#### Inherited from [#inherited-from-39]

`Omit.aria-colindextext`

#### Defined in [#defined-in-169]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2624

***

### aria-colspan? [#aria-colspan]

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See [#see-9]

* aria-colindex
* aria-rowspan.

#### Inherited from [#inherited-from-40]

`Omit.aria-colspan`

#### Defined in [#defined-in-170]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2629

***

### aria-controls? [#aria-controls]

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See [#see-10]

aria-owns.

#### Inherited from [#inherited-from-41]

`Omit.aria-controls`

#### Defined in [#defined-in-171]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2634

***

### aria-current? [#aria-current]

> `optional` **aria-current**: `boolean` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"` | `"date"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from [#inherited-from-42]

`Omit.aria-current`

#### Defined in [#defined-in-172]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2636

***

### aria-describedby? [#aria-describedby]

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See [#see-11]

aria-labelledby

#### Inherited from [#inherited-from-43]

`Omit.aria-describedby`

#### Defined in [#defined-in-173]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2641

***

### aria-description? [#aria-description]

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See [#see-12]

related aria-describedby.

#### Inherited from [#inherited-from-44]

`Omit.aria-description`

#### Defined in [#defined-in-174]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2646

***

### aria-details? [#aria-details]

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See [#see-13]

aria-describedby.

#### Inherited from [#inherited-from-45]

`Omit.aria-details`

#### Defined in [#defined-in-175]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2651

***

### aria-disabled? [#aria-disabled]

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See [#see-14]

* aria-hidden
* aria-readonly.

#### Inherited from [#inherited-from-46]

`Omit.aria-disabled`

#### Defined in [#defined-in-176]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2656

***

### ~~aria-dropeffect?~~ [#aria-dropeffect]

> `optional` **aria-dropeffect**: `"none"` | `"link"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated [#deprecated]

in ARIA 1.1

#### Inherited from [#inherited-from-47]

`Omit.aria-dropeffect`

#### Defined in [#defined-in-177]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2661

***

### aria-errormessage? [#aria-errormessage]

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See [#see-15]

* aria-invalid
* aria-describedby.

#### Inherited from [#inherited-from-48]

`Omit.aria-errormessage`

#### Defined in [#defined-in-178]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2666

***

### aria-expanded? [#aria-expanded]

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from [#inherited-from-49]

`Omit.aria-expanded`

#### Defined in [#defined-in-179]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2668

***

### aria-flowto? [#aria-flowto]

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
allows assistive technology to override the general default of reading in document source order.

#### Inherited from [#inherited-from-50]

`Omit.aria-flowto`

#### Defined in [#defined-in-180]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2673

***

### ~~aria-grabbed?~~ [#aria-grabbed]

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated [#deprecated-1]

in ARIA 1.1

#### Inherited from [#inherited-from-51]

`Omit.aria-grabbed`

#### Defined in [#defined-in-181]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2678

***

### aria-haspopup? [#aria-haspopup]

> `optional` **aria-haspopup**: `boolean` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from [#inherited-from-52]

`Omit.aria-haspopup`

#### Defined in [#defined-in-182]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2680

***

### aria-hidden? [#aria-hidden]

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See [#see-16]

aria-disabled.

#### Inherited from [#inherited-from-53]

`Omit.aria-hidden`

#### Defined in [#defined-in-183]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2685

***

### aria-invalid? [#aria-invalid]

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See [#see-17]

aria-errormessage.

#### Inherited from [#inherited-from-54]

`Omit.aria-invalid`

#### Defined in [#defined-in-184]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2690

***

### aria-keyshortcuts? [#aria-keyshortcuts]

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from [#inherited-from-55]

`Omit.aria-keyshortcuts`

#### Defined in [#defined-in-185]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2692

***

### aria-label? [#aria-label]

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See [#see-18]

aria-labelledby.

#### Inherited from [#inherited-from-56]

`Omit.aria-label`

#### Defined in [#defined-in-186]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2697

***

### aria-labelledby? [#aria-labelledby]

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See [#see-19]

aria-describedby.

#### Inherited from [#inherited-from-57]

`Omit.aria-labelledby`

#### Defined in [#defined-in-187]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2702

***

### aria-level? [#aria-level]

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from [#inherited-from-58]

`Omit.aria-level`

#### Defined in [#defined-in-188]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2704

***

### aria-live? [#aria-live]

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from [#inherited-from-59]

`Omit.aria-live`

#### Defined in [#defined-in-189]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2706

***

### aria-modal? [#aria-modal]

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from [#inherited-from-60]

`Omit.aria-modal`

#### Defined in [#defined-in-190]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2708

***

### aria-multiline? [#aria-multiline]

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from [#inherited-from-61]

`Omit.aria-multiline`

#### Defined in [#defined-in-191]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2710

***

### aria-multiselectable? [#aria-multiselectable]

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from [#inherited-from-62]

`Omit.aria-multiselectable`

#### Defined in [#defined-in-192]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2712

***

### aria-orientation? [#aria-orientation]

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from [#inherited-from-63]

`Omit.aria-orientation`

#### Defined in [#defined-in-193]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2714

***

### aria-owns? [#aria-owns]

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See [#see-20]

aria-controls.

#### Inherited from [#inherited-from-64]

`Omit.aria-owns`

#### Defined in [#defined-in-194]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2720

***

### aria-placeholder? [#aria-placeholder]

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
A hint could be a sample value or a brief description of the expected format.

#### Inherited from [#inherited-from-65]

`Omit.aria-placeholder`

#### Defined in [#defined-in-195]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2725

***

### aria-posinset? [#aria-posinset]

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See [#see-21]

aria-setsize.

#### Inherited from [#inherited-from-66]

`Omit.aria-posinset`

#### Defined in [#defined-in-196]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2730

***

### aria-pressed? [#aria-pressed]

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See [#see-22]

* aria-checked
* aria-selected.

#### Inherited from [#inherited-from-67]

`Omit.aria-pressed`

#### Defined in [#defined-in-197]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2735

***

### aria-readonly? [#aria-readonly]

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See [#see-23]

aria-disabled.

#### Inherited from [#inherited-from-68]

`Omit.aria-readonly`

#### Defined in [#defined-in-198]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2740

***

### aria-relevant? [#aria-relevant]

> `optional` **aria-relevant**: `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"all"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See [#see-24]

aria-atomic.

#### Inherited from [#inherited-from-69]

`Omit.aria-relevant`

#### Defined in [#defined-in-199]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2745

***

### aria-required? [#aria-required]

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from [#inherited-from-70]

`Omit.aria-required`

#### Defined in [#defined-in-200]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2758

***

### aria-roledescription? [#aria-roledescription]

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from [#inherited-from-71]

`Omit.aria-roledescription`

#### Defined in [#defined-in-201]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2760

***

### aria-rowcount? [#aria-rowcount]

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See [#see-25]

aria-rowindex.

#### Inherited from [#inherited-from-72]

`Omit.aria-rowcount`

#### Defined in [#defined-in-202]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2765

***

### aria-rowindex? [#aria-rowindex]

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See [#see-26]

* aria-rowcount
* aria-rowspan.

#### Inherited from [#inherited-from-73]

`Omit.aria-rowindex`

#### Defined in [#defined-in-203]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2770

***

### aria-rowindextext? [#aria-rowindextext]

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See [#see-27]

aria-colindextext.

#### Inherited from [#inherited-from-74]

`Omit.aria-rowindextext`

#### Defined in [#defined-in-204]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2775

***

### aria-rowspan? [#aria-rowspan]

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See [#see-28]

* aria-rowindex
* aria-colspan.

#### Inherited from [#inherited-from-75]

`Omit.aria-rowspan`

#### Defined in [#defined-in-205]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2780

***

### aria-selected? [#aria-selected]

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See [#see-29]

* aria-checked
* aria-pressed.

#### Inherited from [#inherited-from-76]

`Omit.aria-selected`

#### Defined in [#defined-in-206]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2785

***

### aria-setsize? [#aria-setsize]

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See [#see-30]

aria-posinset.

#### Inherited from [#inherited-from-77]

`Omit.aria-setsize`

#### Defined in [#defined-in-207]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2790

***

### aria-sort? [#aria-sort]

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from [#inherited-from-78]

`Omit.aria-sort`

#### Defined in [#defined-in-208]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2792

***

### aria-valuemax? [#aria-valuemax]

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from [#inherited-from-79]

`Omit.aria-valuemax`

#### Defined in [#defined-in-209]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2794

***

### aria-valuemin? [#aria-valuemin]

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from [#inherited-from-80]

`Omit.aria-valuemin`

#### Defined in [#defined-in-210]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2796

***

### aria-valuenow? [#aria-valuenow]

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See [#see-31]

aria-valuetext.

#### Inherited from [#inherited-from-81]

`Omit.aria-valuenow`

#### Defined in [#defined-in-211]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2801

***

### aria-valuetext? [#aria-valuetext]

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from [#inherited-from-82]

`Omit.aria-valuetext`

#### Defined in [#defined-in-212]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2803

***

### ascent? [#ascent]

> `optional` **ascent**: `string` | `number`

#### Inherited from [#inherited-from-83]

`Omit.ascent`

#### Defined in [#defined-in-213]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3740

***

### attributeName? [#attributename]

> `optional` **attributeName**: `string`

#### Inherited from [#inherited-from-84]

`Omit.attributeName`

#### Defined in [#defined-in-214]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3741

***

### attributeType? [#attributetype]

> `optional` **attributeType**: `string`

#### Inherited from [#inherited-from-85]

`Omit.attributeType`

#### Defined in [#defined-in-215]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3742

***

### autoReverse? [#autoreverse]

> `optional` **autoReverse**: `Booleanish`

#### Inherited from [#inherited-from-86]

`Omit.autoReverse`

#### Defined in [#defined-in-216]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3743

***

### azimuth? [#azimuth]

> `optional` **azimuth**: `string` | `number`

#### Inherited from [#inherited-from-87]

`Omit.azimuth`

#### Defined in [#defined-in-217]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3744

***

### baseFrequency? [#basefrequency]

> `optional` **baseFrequency**: `string` | `number`

#### Inherited from [#inherited-from-88]

`Omit.baseFrequency`

#### Defined in [#defined-in-218]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3745

***

### baselineShift? [#baselineshift]

> `optional` **baselineShift**: `string` | `number`

#### Inherited from [#inherited-from-89]

`Omit.baselineShift`

#### Defined in [#defined-in-219]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3746

***

### baseProfile? [#baseprofile]

> `optional` **baseProfile**: `string` | `number`

#### Inherited from [#inherited-from-90]

`Omit.baseProfile`

#### Defined in [#defined-in-220]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3747

***

### bbox? [#bbox]

> `optional` **bbox**: `string` | `number`

#### Inherited from [#inherited-from-91]

`Omit.bbox`

#### Defined in [#defined-in-221]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3748

***

### begin? [#begin]

> `optional` **begin**: `string` | `number`

#### Inherited from [#inherited-from-92]

`Omit.begin`

#### Defined in [#defined-in-222]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3749

***

### bias? [#bias]

> `optional` **bias**: `string` | `number`

#### Inherited from [#inherited-from-93]

`Omit.bias`

#### Defined in [#defined-in-223]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3750

***

### by? [#by]

> `optional` **by**: `string` | `number`

#### Inherited from [#inherited-from-94]

`Omit.by`

#### Defined in [#defined-in-224]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3751

***

### calcMode? [#calcmode]

> `optional` **calcMode**: `string` | `number`

#### Inherited from [#inherited-from-95]

`Omit.calcMode`

#### Defined in [#defined-in-225]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3752

***

### capHeight? [#capheight]

> `optional` **capHeight**: `string` | `number`

#### Inherited from [#inherited-from-96]

`Omit.capHeight`

#### Defined in [#defined-in-226]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3753

***

### className? [#classname]

> `optional` **className**: `string`

#### Inherited from [#inherited-from-97]

`Omit.className`

#### Defined in [#defined-in-227]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3694

***

### clip? [#clip]

> `optional` **clip**: `string` | `number`

#### Inherited from [#inherited-from-98]

`Omit.clip`

#### Defined in [#defined-in-228]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3754

***

### clipPath? [#clippath]

> `optional` **clipPath**: `string`

#### Inherited from [#inherited-from-99]

`Omit.clipPath`

#### Defined in [#defined-in-229]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3755

***

### clipPathUnits? [#clippathunits]

> `optional` **clipPathUnits**: `string` | `number`

#### Inherited from [#inherited-from-100]

`Omit.clipPathUnits`

#### Defined in [#defined-in-230]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3756

***

### clipRule? [#cliprule]

> `optional` **clipRule**: `string` | `number`

#### Inherited from [#inherited-from-101]

`Omit.clipRule`

#### Defined in [#defined-in-231]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3757

***

### color? [#color]

> `optional` **color**: `string`

#### Inherited from [#inherited-from-102]

`Omit.color`

#### Defined in [#defined-in-232]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3695

***

### colorInterpolation? [#colorinterpolation]

> `optional` **colorInterpolation**: `string` | `number`

#### Inherited from [#inherited-from-103]

`Omit.colorInterpolation`

#### Defined in [#defined-in-233]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3758

***

### colorInterpolationFilters? [#colorinterpolationfilters]

> `optional` **colorInterpolationFilters**: `"inherit"` | `"auto"` | `"sRGB"` | `"linearRGB"`

#### Inherited from [#inherited-from-104]

`Omit.colorInterpolationFilters`

#### Defined in [#defined-in-234]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3759

***

### colorProfile? [#colorprofile]

> `optional` **colorProfile**: `string` | `number`

#### Inherited from [#inherited-from-105]

`Omit.colorProfile`

#### Defined in [#defined-in-235]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3760

***

### colorRendering? [#colorrendering]

> `optional` **colorRendering**: `string` | `number`

#### Inherited from [#inherited-from-106]

`Omit.colorRendering`

#### Defined in [#defined-in-236]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3761

***

### contentScriptType? [#contentscripttype]

> `optional` **contentScriptType**: `string` | `number`

#### Inherited from [#inherited-from-107]

`Omit.contentScriptType`

#### Defined in [#defined-in-237]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3762

***

### contentStyleType? [#contentstyletype]

> `optional` **contentStyleType**: `string` | `number`

#### Inherited from [#inherited-from-108]

`Omit.contentStyleType`

#### Defined in [#defined-in-238]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3763

***

### crossOrigin? [#crossorigin]

> `optional` **crossOrigin**: `CrossOrigin`

#### Inherited from [#inherited-from-109]

`Omit.crossOrigin`

#### Defined in [#defined-in-239]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3715

***

### cursor? [#cursor]

> `optional` **cursor**: `string` | `number`

#### Inherited from [#inherited-from-110]

`Omit.cursor`

#### Defined in [#defined-in-240]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3764

***

### cx? [#cx]

> `optional` **cx**: `string` | `number`

#### Inherited from [#inherited-from-111]

`Omit.cx`

#### Defined in [#defined-in-241]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3765

***

### cy? [#cy]

> `optional` **cy**: `string` | `number`

#### Inherited from [#inherited-from-112]

`Omit.cy`

#### Defined in [#defined-in-242]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3766

***

### d? [#d]

> `optional` **d**: `string`

#### Inherited from [#inherited-from-113]

`Omit.d`

#### Defined in [#defined-in-243]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3767

***

### dangerouslySetInnerHTML? [#dangerouslysetinnerhtml]

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html [#__html]

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from [#inherited-from-114]

`Omit.dangerouslySetInnerHTML`

#### Defined in [#defined-in-244]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2362

***

### decelerate? [#decelerate]

> `optional` **decelerate**: `string` | `number`

#### Inherited from [#inherited-from-115]

`Omit.decelerate`

#### Defined in [#defined-in-245]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3768

***

### descent? [#descent]

> `optional` **descent**: `string` | `number`

#### Inherited from [#inherited-from-116]

`Omit.descent`

#### Defined in [#defined-in-246]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3769

***

### diffuseConstant? [#diffuseconstant]

> `optional` **diffuseConstant**: `string` | `number`

#### Inherited from [#inherited-from-117]

`Omit.diffuseConstant`

#### Defined in [#defined-in-247]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3770

***

### direction? [#direction]

> `optional` **direction**: `string` | `number`

#### Inherited from [#inherited-from-118]

`Omit.direction`

#### Defined in [#defined-in-248]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3771

***

### display? [#display]

> `optional` **display**: `string` | `number`

#### Inherited from [#inherited-from-119]

`Omit.display`

#### Defined in [#defined-in-249]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3772

***

### divisor? [#divisor]

> `optional` **divisor**: `string` | `number`

#### Inherited from [#inherited-from-120]

`Omit.divisor`

#### Defined in [#defined-in-250]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3773

***

### dominantBaseline? [#dominantbaseline]

> `optional` **dominantBaseline**: `"inherit"` | `"auto"` | `"alphabetic"` | `"hanging"` | `"ideographic"` | `"mathematical"` | `"text-before-edge"` | `"middle"` | `"central"` | `"text-after-edge"` | `"use-script"` | `"no-change"` | `"reset-size"`

#### Inherited from [#inherited-from-121]

`Omit.dominantBaseline`

#### Defined in [#defined-in-251]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3774

***

### dur? [#dur]

> `optional` **dur**: `string` | `number`

#### Inherited from [#inherited-from-122]

`Omit.dur`

#### Defined in [#defined-in-252]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3789

***

### dx? [#dx]

> `optional` **dx**: `string` | `number`

#### Inherited from [#inherited-from-123]

`Omit.dx`

#### Defined in [#defined-in-253]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3790

***

### dy? [#dy]

> `optional` **dy**: `string` | `number`

#### Inherited from [#inherited-from-124]

`Omit.dy`

#### Defined in [#defined-in-254]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3791

***

### edgeMode? [#edgemode]

> `optional` **edgeMode**: `string` | `number`

#### Inherited from [#inherited-from-125]

`Omit.edgeMode`

#### Defined in [#defined-in-255]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3792

***

### elevation? [#elevation]

> `optional` **elevation**: `string` | `number`

#### Inherited from [#inherited-from-126]

`Omit.elevation`

#### Defined in [#defined-in-256]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3793

***

### enableBackground? [#enablebackground]

> `optional` **enableBackground**: `string` | `number`

#### Inherited from [#inherited-from-127]

`Omit.enableBackground`

#### Defined in [#defined-in-257]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3794

***

### end? [#end]

> `optional` **end**: `string` | `number`

#### Inherited from [#inherited-from-128]

`Omit.end`

#### Defined in [#defined-in-258]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3795

***

### exponent? [#exponent]

> `optional` **exponent**: `string` | `number`

#### Inherited from [#inherited-from-129]

`Omit.exponent`

#### Defined in [#defined-in-259]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3796

***

### externalResourcesRequired? [#externalresourcesrequired]

> `optional` **externalResourcesRequired**: `Booleanish`

#### Inherited from [#inherited-from-130]

`Omit.externalResourcesRequired`

#### Defined in [#defined-in-260]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3797

***

### fill? [#fill]

> `optional` **fill**: `string`

#### Inherited from [#inherited-from-131]

`Omit.fill`

#### Defined in [#defined-in-261]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3798

***

### fillOpacity? [#fillopacity]

> `optional` **fillOpacity**: `string` | `number`

#### Inherited from [#inherited-from-132]

`Omit.fillOpacity`

#### Defined in [#defined-in-262]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3799

***

### fillRule? [#fillrule]

> `optional` **fillRule**: `"inherit"` | `"nonzero"` | `"evenodd"`

#### Inherited from [#inherited-from-133]

`Omit.fillRule`

#### Defined in [#defined-in-263]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3800

***

### filter? [#filter]

> `optional` **filter**: `string`

#### Inherited from [#inherited-from-134]

`Omit.filter`

#### Defined in [#defined-in-264]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3801

***

### filterRes? [#filterres]

> `optional` **filterRes**: `string` | `number`

#### Inherited from [#inherited-from-135]

`Omit.filterRes`

#### Defined in [#defined-in-265]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3802

***

### filterUnits? [#filterunits]

> `optional` **filterUnits**: `string` | `number`

#### Inherited from [#inherited-from-136]

`Omit.filterUnits`

#### Defined in [#defined-in-266]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3803

***

### floodColor? [#floodcolor]

> `optional` **floodColor**: `string` | `number`

#### Inherited from [#inherited-from-137]

`Omit.floodColor`

#### Defined in [#defined-in-267]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3804

***

### floodOpacity? [#floodopacity]

> `optional` **floodOpacity**: `string` | `number`

#### Inherited from [#inherited-from-138]

`Omit.floodOpacity`

#### Defined in [#defined-in-268]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3805

***

### focusable? [#focusable]

> `optional` **focusable**: `"auto"` | `Booleanish`

#### Inherited from [#inherited-from-139]

`Omit.focusable`

#### Defined in [#defined-in-269]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3806

***

### fontFamily? [#fontfamily]

> `optional` **fontFamily**: `string`

#### Inherited from [#inherited-from-140]

`Omit.fontFamily`

#### Defined in [#defined-in-270]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3807

***

### fontSize? [#fontsize]

> `optional` **fontSize**: `string` | `number`

#### Inherited from [#inherited-from-141]

`Omit.fontSize`

#### Defined in [#defined-in-271]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3808

***

### fontSizeAdjust? [#fontsizeadjust]

> `optional` **fontSizeAdjust**: `string` | `number`

#### Inherited from [#inherited-from-142]

`Omit.fontSizeAdjust`

#### Defined in [#defined-in-272]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3809

***

### fontStretch? [#fontstretch]

> `optional` **fontStretch**: `string` | `number`

#### Inherited from [#inherited-from-143]

`Omit.fontStretch`

#### Defined in [#defined-in-273]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3810

***

### fontStyle? [#fontstyle]

> `optional` **fontStyle**: `string` | `number`

#### Inherited from [#inherited-from-144]

`Omit.fontStyle`

#### Defined in [#defined-in-274]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3811

***

### fontVariant? [#fontvariant]

> `optional` **fontVariant**: `string` | `number`

#### Inherited from [#inherited-from-145]

`Omit.fontVariant`

#### Defined in [#defined-in-275]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3812

***

### fontWeight? [#fontweight]

> `optional` **fontWeight**: `string` | `number`

#### Inherited from [#inherited-from-146]

`Omit.fontWeight`

#### Defined in [#defined-in-276]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3813

***

### format? [#format]

> `optional` **format**: `string` | `number`

#### Inherited from [#inherited-from-147]

`Omit.format`

#### Defined in [#defined-in-277]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3814

***

### fr? [#fr]

> `optional` **fr**: `string` | `number`

#### Inherited from [#inherited-from-148]

`Omit.fr`

#### Defined in [#defined-in-278]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3815

***

### from? [#from]

> `optional` **from**: `string` | `number`

#### Inherited from [#inherited-from-149]

`Omit.from`

#### Defined in [#defined-in-279]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3816

***

### fx? [#fx]

> `optional` **fx**: `string` | `number`

#### Inherited from [#inherited-from-150]

`Omit.fx`

#### Defined in [#defined-in-280]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3817

***

### fy? [#fy]

> `optional` **fy**: `string` | `number`

#### Inherited from [#inherited-from-151]

`Omit.fy`

#### Defined in [#defined-in-281]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3818

***

### g1? [#g1]

> `optional` **g1**: `string` | `number`

#### Inherited from [#inherited-from-152]

`Omit.g1`

#### Defined in [#defined-in-282]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3819

***

### g2? [#g2]

> `optional` **g2**: `string` | `number`

#### Inherited from [#inherited-from-153]

`Omit.g2`

#### Defined in [#defined-in-283]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3820

***

### glyphName? [#glyphname]

> `optional` **glyphName**: `string` | `number`

#### Inherited from [#inherited-from-154]

`Omit.glyphName`

#### Defined in [#defined-in-284]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3821

***

### glyphOrientationHorizontal? [#glyphorientationhorizontal]

> `optional` **glyphOrientationHorizontal**: `string` | `number`

#### Inherited from [#inherited-from-155]

`Omit.glyphOrientationHorizontal`

#### Defined in [#defined-in-285]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3822

***

### glyphOrientationVertical? [#glyphorientationvertical]

> `optional` **glyphOrientationVertical**: `string` | `number`

#### Inherited from [#inherited-from-156]

`Omit.glyphOrientationVertical`

#### Defined in [#defined-in-286]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3823

***

### glyphRef? [#glyphref]

> `optional` **glyphRef**: `string` | `number`

#### Inherited from [#inherited-from-157]

`Omit.glyphRef`

#### Defined in [#defined-in-287]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3824

***

### gradientTransform? [#gradienttransform]

> `optional` **gradientTransform**: `string`

#### Inherited from [#inherited-from-158]

`Omit.gradientTransform`

#### Defined in [#defined-in-288]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3825

***

### gradientUnits? [#gradientunits]

> `optional` **gradientUnits**: `string`

#### Inherited from [#inherited-from-159]

`Omit.gradientUnits`

#### Defined in [#defined-in-289]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3826

***

### hanging? [#hanging]

> `optional` **hanging**: `string` | `number`

#### Inherited from [#inherited-from-160]

`Omit.hanging`

#### Defined in [#defined-in-290]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3827

***

### height? [#height]

> `optional` **height**: `string` | `number`

#### Inherited from [#inherited-from-161]

`Omit.height`

#### Defined in [#defined-in-291]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3696

***

### horizAdvX? [#horizadvx]

> `optional` **horizAdvX**: `string` | `number`

#### Inherited from [#inherited-from-162]

`Omit.horizAdvX`

#### Defined in [#defined-in-292]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3828

***

### horizOriginX? [#horizoriginx]

> `optional` **horizOriginX**: `string` | `number`

#### Inherited from [#inherited-from-163]

`Omit.horizOriginX`

#### Defined in [#defined-in-293]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3829

***

### href? [#href]

> `optional` **href**: `string`

#### Inherited from [#inherited-from-164]

`Omit.href`

#### Defined in [#defined-in-294]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3830

***

### id? [#id-1]

> `optional` **id**: `string`

#### Inherited from [#inherited-from-165]

`Omit.id`

#### Defined in [#defined-in-295]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3697

***

### ideographic? [#ideographic]

> `optional` **ideographic**: `string` | `number`

#### Inherited from [#inherited-from-166]

`Omit.ideographic`

#### Defined in [#defined-in-296]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3831

***

### imageRendering? [#imagerendering]

> `optional` **imageRendering**: `string` | `number`

#### Inherited from [#inherited-from-167]

`Omit.imageRendering`

#### Defined in [#defined-in-297]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3832

***

### in? [#in]

> `optional` **in**: `string`

#### Inherited from [#inherited-from-168]

`Omit.in`

#### Defined in [#defined-in-298]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3834

***

### in2? [#in2]

> `optional` **in2**: `string` | `number`

#### Inherited from [#inherited-from-169]

`Omit.in2`

#### Defined in [#defined-in-299]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3833

***

### intercept? [#intercept]

> `optional` **intercept**: `string` | `number`

#### Inherited from [#inherited-from-170]

`Omit.intercept`

#### Defined in [#defined-in-300]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3835

***

### k? [#k]

> `optional` **k**: `string` | `number`

#### Inherited from [#inherited-from-171]

`Omit.k`

#### Defined in [#defined-in-301]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3840

***

### k1? [#k1]

> `optional` **k1**: `string` | `number`

#### Inherited from [#inherited-from-172]

`Omit.k1`

#### Defined in [#defined-in-302]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3836

***

### k2? [#k2]

> `optional` **k2**: `string` | `number`

#### Inherited from [#inherited-from-173]

`Omit.k2`

#### Defined in [#defined-in-303]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3837

***

### k3? [#k3]

> `optional` **k3**: `string` | `number`

#### Inherited from [#inherited-from-174]

`Omit.k3`

#### Defined in [#defined-in-304]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3838

***

### k4? [#k4]

> `optional` **k4**: `string` | `number`

#### Inherited from [#inherited-from-175]

`Omit.k4`

#### Defined in [#defined-in-305]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3839

***

### kernelMatrix? [#kernelmatrix]

> `optional` **kernelMatrix**: `string` | `number`

#### Inherited from [#inherited-from-176]

`Omit.kernelMatrix`

#### Defined in [#defined-in-306]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3841

***

### kernelUnitLength? [#kernelunitlength]

> `optional` **kernelUnitLength**: `string` | `number`

#### Inherited from [#inherited-from-177]

`Omit.kernelUnitLength`

#### Defined in [#defined-in-307]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3842

***

### kerning? [#kerning]

> `optional` **kerning**: `string` | `number`

#### Inherited from [#inherited-from-178]

`Omit.kerning`

#### Defined in [#defined-in-308]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3843

***

### key? [#key]

> `optional` **key**: `null` | `Key`

#### Inherited from [#inherited-from-179]

`Omit.key`

#### Defined in [#defined-in-309]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:259

***

### keyPoints? [#keypoints]

> `optional` **keyPoints**: `string` | `number`

#### Inherited from [#inherited-from-180]

`Omit.keyPoints`

#### Defined in [#defined-in-310]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3844

***

### keySplines? [#keysplines]

> `optional` **keySplines**: `string` | `number`

#### Inherited from [#inherited-from-181]

`Omit.keySplines`

#### Defined in [#defined-in-311]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3845

***

### keyTimes? [#keytimes]

> `optional` **keyTimes**: `string` | `number`

#### Inherited from [#inherited-from-182]

`Omit.keyTimes`

#### Defined in [#defined-in-312]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3846

***

### lang? [#lang]

> `optional` **lang**: `string`

#### Inherited from [#inherited-from-183]

`Omit.lang`

#### Defined in [#defined-in-313]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3698

***

### lengthAdjust? [#lengthadjust]

> `optional` **lengthAdjust**: `string` | `number`

#### Inherited from [#inherited-from-184]

`Omit.lengthAdjust`

#### Defined in [#defined-in-314]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3847

***

### letterSpacing? [#letterspacing]

> `optional` **letterSpacing**: `string` | `number`

#### Inherited from [#inherited-from-185]

`Omit.letterSpacing`

#### Defined in [#defined-in-315]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3848

***

### lightingColor? [#lightingcolor]

> `optional` **lightingColor**: `string` | `number`

#### Inherited from [#inherited-from-186]

`Omit.lightingColor`

#### Defined in [#defined-in-316]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3849

***

### limitingConeAngle? [#limitingconeangle]

> `optional` **limitingConeAngle**: `string` | `number`

#### Inherited from [#inherited-from-187]

`Omit.limitingConeAngle`

#### Defined in [#defined-in-317]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3850

***

### local? [#local]

> `optional` **local**: `string` | `number`

#### Inherited from [#inherited-from-188]

`Omit.local`

#### Defined in [#defined-in-318]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3851

***

### markerEnd? [#markerend]

> `optional` **markerEnd**: `string`

#### Inherited from [#inherited-from-189]

`Omit.markerEnd`

#### Defined in [#defined-in-319]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3852

***

### markerHeight? [#markerheight]

> `optional` **markerHeight**: `string` | `number`

#### Inherited from [#inherited-from-190]

`Omit.markerHeight`

#### Defined in [#defined-in-320]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3853

***

### markerMid? [#markermid]

> `optional` **markerMid**: `string`

#### Inherited from [#inherited-from-191]

`Omit.markerMid`

#### Defined in [#defined-in-321]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3854

***

### markerStart? [#markerstart]

> `optional` **markerStart**: `string`

#### Inherited from [#inherited-from-192]

`Omit.markerStart`

#### Defined in [#defined-in-322]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3855

***

### markerUnits? [#markerunits]

> `optional` **markerUnits**: `string` | `number`

#### Inherited from [#inherited-from-193]

`Omit.markerUnits`

#### Defined in [#defined-in-323]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3856

***

### markerWidth? [#markerwidth]

> `optional` **markerWidth**: `string` | `number`

#### Inherited from [#inherited-from-194]

`Omit.markerWidth`

#### Defined in [#defined-in-324]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3857

***

### mask? [#mask]

> `optional` **mask**: `string`

#### Inherited from [#inherited-from-195]

`Omit.mask`

#### Defined in [#defined-in-325]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3858

***

### maskContentUnits? [#maskcontentunits]

> `optional` **maskContentUnits**: `string` | `number`

#### Inherited from [#inherited-from-196]

`Omit.maskContentUnits`

#### Defined in [#defined-in-326]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3859

***

### maskUnits? [#maskunits]

> `optional` **maskUnits**: `string` | `number`

#### Inherited from [#inherited-from-197]

`Omit.maskUnits`

#### Defined in [#defined-in-327]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3860

***

### mathematical? [#mathematical]

> `optional` **mathematical**: `string` | `number`

#### Inherited from [#inherited-from-198]

`Omit.mathematical`

#### Defined in [#defined-in-328]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3861

***

### max? [#max]

> `optional` **max**: `string` | `number`

#### Inherited from [#inherited-from-199]

`Omit.max`

#### Defined in [#defined-in-329]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3699

***

### media? [#media]

> `optional` **media**: `string`

#### Inherited from [#inherited-from-200]

`Omit.media`

#### Defined in [#defined-in-330]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3700

***

### method? [#method]

> `optional` **method**: `string`

#### Inherited from [#inherited-from-201]

`Omit.method`

#### Defined in [#defined-in-331]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3701

***

### min? [#min]

> `optional` **min**: `string` | `number`

#### Inherited from [#inherited-from-202]

`Omit.min`

#### Defined in [#defined-in-332]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3702

***

### mode? [#mode]

> `optional` **mode**: `string` | `number`

#### Inherited from [#inherited-from-203]

`Omit.mode`

#### Defined in [#defined-in-333]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3862

***

### name? [#name-2]

> `optional` **name**: `string`

#### Inherited from [#inherited-from-204]

`Omit.name`

#### Defined in [#defined-in-334]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3703

***

### nonce? [#nonce]

> `optional` **nonce**: `string`

#### Inherited from [#inherited-from-205]

`Omit.nonce`

#### Defined in [#defined-in-335]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3704

***

### numOctaves? [#numoctaves]

> `optional` **numOctaves**: `string` | `number`

#### Inherited from [#inherited-from-206]

`Omit.numOctaves`

#### Defined in [#defined-in-336]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3863

***

### offset? [#offset]

> `optional` **offset**: `string` | `number`

#### Inherited from [#inherited-from-207]

`Omit.offset`

#### Defined in [#defined-in-337]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3864

***

### onAbort? [#onabort]

> `optional` **onAbort**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-208]

`Omit.onAbort`

#### Defined in [#defined-in-338]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2421

***

### onAbortCapture? [#onabortcapture]

> `optional` **onAbortCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-209]

`Omit.onAbortCapture`

#### Defined in [#defined-in-339]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2422

***

### onAnimationEnd? [#onanimationend]

> `optional` **onAnimationEnd**: `AnimationEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-210]

`Omit.onAnimationEnd`

#### Defined in [#defined-in-340]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2551

***

### onAnimationEndCapture? [#onanimationendcapture]

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-211]

`Omit.onAnimationEndCapture`

#### Defined in [#defined-in-341]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2552

***

### onAnimationIteration? [#onanimationiteration]

> `optional` **onAnimationIteration**: `AnimationEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-212]

`Omit.onAnimationIteration`

#### Defined in [#defined-in-342]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2553

***

### onAnimationIterationCapture? [#onanimationiterationcapture]

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-213]

`Omit.onAnimationIterationCapture`

#### Defined in [#defined-in-343]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2554

***

### onAnimationStart? [#onanimationstart]

> `optional` **onAnimationStart**: `AnimationEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-214]

`Omit.onAnimationStart`

#### Defined in [#defined-in-344]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2549

***

### onAnimationStartCapture? [#onanimationstartcapture]

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-215]

`Omit.onAnimationStartCapture`

#### Defined in [#defined-in-345]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2550

***

### onAuxClick? [#onauxclick]

> `optional` **onAuxClick**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-216]

`Omit.onAuxClick`

#### Defined in [#defined-in-346]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2467

***

### onAuxClickCapture? [#onauxclickcapture]

> `optional` **onAuxClickCapture**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-217]

`Omit.onAuxClickCapture`

#### Defined in [#defined-in-347]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2468

***

### onBeforeInput? [#onbeforeinput]

> `optional` **onBeforeInput**: `InputEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-218]

`Omit.onBeforeInput`

#### Defined in [#defined-in-348]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2393

***

### onBeforeInputCapture? [#onbeforeinputcapture]

> `optional` **onBeforeInputCapture**: `InputEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-219]

`Omit.onBeforeInputCapture`

#### Defined in [#defined-in-349]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2394

***

### onBeforeToggle? [#onbeforetoggle]

> `optional` **onBeforeToggle**: `ToggleEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-220]

`Omit.onBeforeToggle`

#### Defined in [#defined-in-350]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2558

***

### onBlur? [#onblur]

> `optional` **onBlur**: `FocusEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-221]

`Omit.onBlur`

#### Defined in [#defined-in-351]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2387

***

### onBlurCapture? [#onblurcapture]

> `optional` **onBlurCapture**: `FocusEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-222]

`Omit.onBlurCapture`

#### Defined in [#defined-in-352]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2388

***

### onCanPlay? [#oncanplay]

> `optional` **onCanPlay**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-223]

`Omit.onCanPlay`

#### Defined in [#defined-in-353]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2423

***

### onCanPlayCapture? [#oncanplaycapture]

> `optional` **onCanPlayCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-224]

`Omit.onCanPlayCapture`

#### Defined in [#defined-in-354]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2424

***

### onCanPlayThrough? [#oncanplaythrough]

> `optional` **onCanPlayThrough**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-225]

`Omit.onCanPlayThrough`

#### Defined in [#defined-in-355]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2425

***

### onCanPlayThroughCapture? [#oncanplaythroughcapture]

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-226]

`Omit.onCanPlayThroughCapture`

#### Defined in [#defined-in-356]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2426

***

### onChange? [#onchange]

> `optional` **onChange**: `ChangeEventHandler`\<`SVGSVGElement`, `Element`>

#### Inherited from [#inherited-from-227]

`Omit.onChange`

#### Defined in [#defined-in-357]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2391

***

### onChangeCapture? [#onchangecapture]

> `optional` **onChangeCapture**: `ChangeEventHandler`\<`SVGSVGElement`, `Element`>

#### Inherited from [#inherited-from-228]

`Omit.onChangeCapture`

#### Defined in [#defined-in-358]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2392

***

### onClick? [#onclick]

> `optional` **onClick**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-229]

`Omit.onClick`

#### Defined in [#defined-in-359]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2469

***

### onClickCapture? [#onclickcapture]

> `optional` **onClickCapture**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-230]

`Omit.onClickCapture`

#### Defined in [#defined-in-360]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2470

***

### onCompositionEnd? [#oncompositionend]

> `optional` **onCompositionEnd**: `CompositionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-231]

`Omit.onCompositionEnd`

#### Defined in [#defined-in-361]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2377

***

### onCompositionEndCapture? [#oncompositionendcapture]

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-232]

`Omit.onCompositionEndCapture`

#### Defined in [#defined-in-362]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2378

***

### onCompositionStart? [#oncompositionstart]

> `optional` **onCompositionStart**: `CompositionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-233]

`Omit.onCompositionStart`

#### Defined in [#defined-in-363]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2379

***

### onCompositionStartCapture? [#oncompositionstartcapture]

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-234]

`Omit.onCompositionStartCapture`

#### Defined in [#defined-in-364]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2380

***

### onCompositionUpdate? [#oncompositionupdate]

> `optional` **onCompositionUpdate**: `CompositionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-235]

`Omit.onCompositionUpdate`

#### Defined in [#defined-in-365]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2381

***

### onCompositionUpdateCapture? [#oncompositionupdatecapture]

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-236]

`Omit.onCompositionUpdateCapture`

#### Defined in [#defined-in-366]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2382

***

### onContextMenu? [#oncontextmenu]

> `optional` **onContextMenu**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-237]

`Omit.onContextMenu`

#### Defined in [#defined-in-367]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2471

***

### onContextMenuCapture? [#oncontextmenucapture]

> `optional` **onContextMenuCapture**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-238]

`Omit.onContextMenuCapture`

#### Defined in [#defined-in-368]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2472

***

### onCopy? [#oncopy]

> `optional` **onCopy**: `ClipboardEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-239]

`Omit.onCopy`

#### Defined in [#defined-in-369]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2369

***

### onCopyCapture? [#oncopycapture]

> `optional` **onCopyCapture**: `ClipboardEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-240]

`Omit.onCopyCapture`

#### Defined in [#defined-in-370]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2370

***

### onCut? [#oncut]

> `optional` **onCut**: `ClipboardEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-241]

`Omit.onCut`

#### Defined in [#defined-in-371]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2371

***

### onCutCapture? [#oncutcapture]

> `optional` **onCutCapture**: `ClipboardEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-242]

`Omit.onCutCapture`

#### Defined in [#defined-in-372]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2372

***

### onDoubleClick? [#ondoubleclick]

> `optional` **onDoubleClick**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-243]

`Omit.onDoubleClick`

#### Defined in [#defined-in-373]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2473

***

### onDoubleClickCapture? [#ondoubleclickcapture]

> `optional` **onDoubleClickCapture**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-244]

`Omit.onDoubleClickCapture`

#### Defined in [#defined-in-374]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2474

***

### onDrag? [#ondrag]

> `optional` **onDrag**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-245]

`Omit.onDrag`

#### Defined in [#defined-in-375]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2475

***

### onDragCapture? [#ondragcapture]

> `optional` **onDragCapture**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-246]

`Omit.onDragCapture`

#### Defined in [#defined-in-376]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2476

***

### onDragEnd? [#ondragend]

> `optional` **onDragEnd**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-247]

`Omit.onDragEnd`

#### Defined in [#defined-in-377]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2477

***

### onDragEndCapture? [#ondragendcapture]

> `optional` **onDragEndCapture**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-248]

`Omit.onDragEndCapture`

#### Defined in [#defined-in-378]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2478

***

### onDragEnter? [#ondragenter]

> `optional` **onDragEnter**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-249]

`Omit.onDragEnter`

#### Defined in [#defined-in-379]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2479

***

### onDragEnterCapture? [#ondragentercapture]

> `optional` **onDragEnterCapture**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-250]

`Omit.onDragEnterCapture`

#### Defined in [#defined-in-380]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2480

***

### onDragExit? [#ondragexit]

> `optional` **onDragExit**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-251]

`Omit.onDragExit`

#### Defined in [#defined-in-381]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2481

***

### onDragExitCapture? [#ondragexitcapture]

> `optional` **onDragExitCapture**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-252]

`Omit.onDragExitCapture`

#### Defined in [#defined-in-382]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2482

***

### onDragLeave? [#ondragleave]

> `optional` **onDragLeave**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-253]

`Omit.onDragLeave`

#### Defined in [#defined-in-383]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2483

***

### onDragLeaveCapture? [#ondragleavecapture]

> `optional` **onDragLeaveCapture**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-254]

`Omit.onDragLeaveCapture`

#### Defined in [#defined-in-384]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2484

***

### onDragOver? [#ondragover]

> `optional` **onDragOver**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-255]

`Omit.onDragOver`

#### Defined in [#defined-in-385]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2485

***

### onDragOverCapture? [#ondragovercapture]

> `optional` **onDragOverCapture**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-256]

`Omit.onDragOverCapture`

#### Defined in [#defined-in-386]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2486

***

### onDragStart? [#ondragstart]

> `optional` **onDragStart**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-257]

`Omit.onDragStart`

#### Defined in [#defined-in-387]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2487

***

### onDragStartCapture? [#ondragstartcapture]

> `optional` **onDragStartCapture**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-258]

`Omit.onDragStartCapture`

#### Defined in [#defined-in-388]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2488

***

### onDrop? [#ondrop]

> `optional` **onDrop**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-259]

`Omit.onDrop`

#### Defined in [#defined-in-389]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2489

***

### onDropCapture? [#ondropcapture]

> `optional` **onDropCapture**: `DragEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-260]

`Omit.onDropCapture`

#### Defined in [#defined-in-390]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2490

***

### onDurationChange? [#ondurationchange]

> `optional` **onDurationChange**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-261]

`Omit.onDurationChange`

#### Defined in [#defined-in-391]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2427

***

### onDurationChangeCapture? [#ondurationchangecapture]

> `optional` **onDurationChangeCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-262]

`Omit.onDurationChangeCapture`

#### Defined in [#defined-in-392]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2428

***

### onEmptied? [#onemptied]

> `optional` **onEmptied**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-263]

`Omit.onEmptied`

#### Defined in [#defined-in-393]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2429

***

### onEmptiedCapture? [#onemptiedcapture]

> `optional` **onEmptiedCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-264]

`Omit.onEmptiedCapture`

#### Defined in [#defined-in-394]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2430

***

### onEncrypted? [#onencrypted]

> `optional` **onEncrypted**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-265]

`Omit.onEncrypted`

#### Defined in [#defined-in-395]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2431

***

### onEncryptedCapture? [#onencryptedcapture]

> `optional` **onEncryptedCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-266]

`Omit.onEncryptedCapture`

#### Defined in [#defined-in-396]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2432

***

### onEnded? [#onended]

> `optional` **onEnded**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-267]

`Omit.onEnded`

#### Defined in [#defined-in-397]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2433

***

### onEndedCapture? [#onendedcapture]

> `optional` **onEndedCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-268]

`Omit.onEndedCapture`

#### Defined in [#defined-in-398]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2434

***

### onError? [#onerror-2]

> `optional` **onError**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-269]

`Omit.onError`

#### Defined in [#defined-in-399]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2407

***

### onErrorCapture? [#onerrorcapture]

> `optional` **onErrorCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-270]

`Omit.onErrorCapture`

#### Defined in [#defined-in-400]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2408

***

### onFocus? [#onfocus]

> `optional` **onFocus**: `FocusEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-271]

`Omit.onFocus`

#### Defined in [#defined-in-401]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2385

***

### onFocusCapture? [#onfocuscapture]

> `optional` **onFocusCapture**: `FocusEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-272]

`Omit.onFocusCapture`

#### Defined in [#defined-in-402]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2386

***

### onGotPointerCapture? [#ongotpointercapture]

> `optional` **onGotPointerCapture**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-273]

`Omit.onGotPointerCapture`

#### Defined in [#defined-in-403]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2533

***

### onGotPointerCaptureCapture? [#ongotpointercapturecapture]

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-274]

`Omit.onGotPointerCaptureCapture`

#### Defined in [#defined-in-404]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2534

***

### onInput? [#oninput]

> `optional` **onInput**: `InputEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-275]

`Omit.onInput`

#### Defined in [#defined-in-405]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2395

***

### onInputCapture? [#oninputcapture]

> `optional` **onInputCapture**: `InputEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-276]

`Omit.onInputCapture`

#### Defined in [#defined-in-406]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2396

***

### onInvalid? [#oninvalid]

> `optional` **onInvalid**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-277]

`Omit.onInvalid`

#### Defined in [#defined-in-407]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2401

***

### onInvalidCapture? [#oninvalidcapture]

> `optional` **onInvalidCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-278]

`Omit.onInvalidCapture`

#### Defined in [#defined-in-408]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2402

***

### onKeyDown? [#onkeydown]

> `optional` **onKeyDown**: `KeyboardEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-279]

`Omit.onKeyDown`

#### Defined in [#defined-in-409]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2411

***

### onKeyDownCapture? [#onkeydowncapture]

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-280]

`Omit.onKeyDownCapture`

#### Defined in [#defined-in-410]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2412

***

### ~~onKeyPress?~~ [#onkeypress]

> `optional` **onKeyPress**: `KeyboardEventHandler`\<`SVGSVGElement`>

#### Deprecated [#deprecated-2]

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from [#inherited-from-281]

`Omit.onKeyPress`

#### Defined in [#defined-in-411]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2414

***

### ~~onKeyPressCapture?~~ [#onkeypresscapture]

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`\<`SVGSVGElement`>

#### Deprecated [#deprecated-3]

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from [#inherited-from-282]

`Omit.onKeyPressCapture`

#### Defined in [#defined-in-412]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2416

***

### onKeyUp? [#onkeyup]

> `optional` **onKeyUp**: `KeyboardEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-283]

`Omit.onKeyUp`

#### Defined in [#defined-in-413]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2417

***

### onKeyUpCapture? [#onkeyupcapture]

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-284]

`Omit.onKeyUpCapture`

#### Defined in [#defined-in-414]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2418

***

### onLoad? [#onload]

> `optional` **onLoad**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-285]

`Omit.onLoad`

#### Defined in [#defined-in-415]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2405

***

### onLoadCapture? [#onloadcapture]

> `optional` **onLoadCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-286]

`Omit.onLoadCapture`

#### Defined in [#defined-in-416]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2406

***

### onLoadedData? [#onloadeddata]

> `optional` **onLoadedData**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-287]

`Omit.onLoadedData`

#### Defined in [#defined-in-417]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2435

***

### onLoadedDataCapture? [#onloadeddatacapture]

> `optional` **onLoadedDataCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-288]

`Omit.onLoadedDataCapture`

#### Defined in [#defined-in-418]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2436

***

### onLoadedMetadata? [#onloadedmetadata]

> `optional` **onLoadedMetadata**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-289]

`Omit.onLoadedMetadata`

#### Defined in [#defined-in-419]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2437

***

### onLoadedMetadataCapture? [#onloadedmetadatacapture]

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-290]

`Omit.onLoadedMetadataCapture`

#### Defined in [#defined-in-420]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2438

***

### onLoadStart? [#onloadstart]

> `optional` **onLoadStart**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-291]

`Omit.onLoadStart`

#### Defined in [#defined-in-421]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2439

***

### onLoadStartCapture? [#onloadstartcapture]

> `optional` **onLoadStartCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-292]

`Omit.onLoadStartCapture`

#### Defined in [#defined-in-422]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2440

***

### onLostPointerCapture? [#onlostpointercapture]

> `optional` **onLostPointerCapture**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-293]

`Omit.onLostPointerCapture`

#### Defined in [#defined-in-423]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2535

***

### onLostPointerCaptureCapture? [#onlostpointercapturecapture]

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-294]

`Omit.onLostPointerCaptureCapture`

#### Defined in [#defined-in-424]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2536

***

### onMouseDown? [#onmousedown]

> `optional` **onMouseDown**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-295]

`Omit.onMouseDown`

#### Defined in [#defined-in-425]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2491

***

### onMouseDownCapture? [#onmousedowncapture]

> `optional` **onMouseDownCapture**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-296]

`Omit.onMouseDownCapture`

#### Defined in [#defined-in-426]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2492

***

### onMouseEnter? [#onmouseenter]

> `optional` **onMouseEnter**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-297]

`Omit.onMouseEnter`

#### Defined in [#defined-in-427]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2493

***

### onMouseLeave? [#onmouseleave]

> `optional` **onMouseLeave**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-298]

`Omit.onMouseLeave`

#### Defined in [#defined-in-428]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2494

***

### onMouseMove? [#onmousemove]

> `optional` **onMouseMove**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-299]

`Omit.onMouseMove`

#### Defined in [#defined-in-429]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2495

***

### onMouseMoveCapture? [#onmousemovecapture]

> `optional` **onMouseMoveCapture**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-300]

`Omit.onMouseMoveCapture`

#### Defined in [#defined-in-430]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2496

***

### onMouseOut? [#onmouseout]

> `optional` **onMouseOut**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-301]

`Omit.onMouseOut`

#### Defined in [#defined-in-431]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2497

***

### onMouseOutCapture? [#onmouseoutcapture]

> `optional` **onMouseOutCapture**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-302]

`Omit.onMouseOutCapture`

#### Defined in [#defined-in-432]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2498

***

### onMouseOver? [#onmouseover]

> `optional` **onMouseOver**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-303]

`Omit.onMouseOver`

#### Defined in [#defined-in-433]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2499

***

### onMouseOverCapture? [#onmouseovercapture]

> `optional` **onMouseOverCapture**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-304]

`Omit.onMouseOverCapture`

#### Defined in [#defined-in-434]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2500

***

### onMouseUp? [#onmouseup]

> `optional` **onMouseUp**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-305]

`Omit.onMouseUp`

#### Defined in [#defined-in-435]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2501

***

### onMouseUpCapture? [#onmouseupcapture]

> `optional` **onMouseUpCapture**: `MouseEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-306]

`Omit.onMouseUpCapture`

#### Defined in [#defined-in-436]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2502

***

### onPaste? [#onpaste]

> `optional` **onPaste**: `ClipboardEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-307]

`Omit.onPaste`

#### Defined in [#defined-in-437]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2373

***

### onPasteCapture? [#onpastecapture]

> `optional` **onPasteCapture**: `ClipboardEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-308]

`Omit.onPasteCapture`

#### Defined in [#defined-in-438]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2374

***

### onPause? [#onpause]

> `optional` **onPause**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-309]

`Omit.onPause`

#### Defined in [#defined-in-439]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2441

***

### onPauseCapture? [#onpausecapture]

> `optional` **onPauseCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-310]

`Omit.onPauseCapture`

#### Defined in [#defined-in-440]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2442

***

### onPlay? [#onplay]

> `optional` **onPlay**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-311]

`Omit.onPlay`

#### Defined in [#defined-in-441]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2443

***

### onPlayCapture? [#onplaycapture]

> `optional` **onPlayCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-312]

`Omit.onPlayCapture`

#### Defined in [#defined-in-442]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2444

***

### onPlaying? [#onplaying]

> `optional` **onPlaying**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-313]

`Omit.onPlaying`

#### Defined in [#defined-in-443]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2445

***

### onPlayingCapture? [#onplayingcapture]

> `optional` **onPlayingCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-314]

`Omit.onPlayingCapture`

#### Defined in [#defined-in-444]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2446

***

### onPointerCancel? [#onpointercancel]

> `optional` **onPointerCancel**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-315]

`Omit.onPointerCancel`

#### Defined in [#defined-in-445]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2525

***

### onPointerCancelCapture? [#onpointercancelcapture]

> `optional` **onPointerCancelCapture**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-316]

`Omit.onPointerCancelCapture`

#### Defined in [#defined-in-446]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2526

***

### onPointerDown? [#onpointerdown]

> `optional` **onPointerDown**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-317]

`Omit.onPointerDown`

#### Defined in [#defined-in-447]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2519

***

### onPointerDownCapture? [#onpointerdowncapture]

> `optional` **onPointerDownCapture**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-318]

`Omit.onPointerDownCapture`

#### Defined in [#defined-in-448]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2520

***

### onPointerEnter? [#onpointerenter]

> `optional` **onPointerEnter**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-319]

`Omit.onPointerEnter`

#### Defined in [#defined-in-449]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2527

***

### onPointerLeave? [#onpointerleave]

> `optional` **onPointerLeave**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-320]

`Omit.onPointerLeave`

#### Defined in [#defined-in-450]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2528

***

### onPointerMove? [#onpointermove]

> `optional` **onPointerMove**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-321]

`Omit.onPointerMove`

#### Defined in [#defined-in-451]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2521

***

### onPointerMoveCapture? [#onpointermovecapture]

> `optional` **onPointerMoveCapture**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-322]

`Omit.onPointerMoveCapture`

#### Defined in [#defined-in-452]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2522

***

### onPointerOut? [#onpointerout]

> `optional` **onPointerOut**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-323]

`Omit.onPointerOut`

#### Defined in [#defined-in-453]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2531

***

### onPointerOutCapture? [#onpointeroutcapture]

> `optional` **onPointerOutCapture**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-324]

`Omit.onPointerOutCapture`

#### Defined in [#defined-in-454]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2532

***

### onPointerOver? [#onpointerover]

> `optional` **onPointerOver**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-325]

`Omit.onPointerOver`

#### Defined in [#defined-in-455]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2529

***

### onPointerOverCapture? [#onpointerovercapture]

> `optional` **onPointerOverCapture**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-326]

`Omit.onPointerOverCapture`

#### Defined in [#defined-in-456]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2530

***

### onPointerUp? [#onpointerup]

> `optional` **onPointerUp**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-327]

`Omit.onPointerUp`

#### Defined in [#defined-in-457]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2523

***

### onPointerUpCapture? [#onpointerupcapture]

> `optional` **onPointerUpCapture**: `PointerEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-328]

`Omit.onPointerUpCapture`

#### Defined in [#defined-in-458]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2524

***

### onProgress? [#onprogress]

> `optional` **onProgress**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-329]

`Omit.onProgress`

#### Defined in [#defined-in-459]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2447

***

### onProgressCapture? [#onprogresscapture]

> `optional` **onProgressCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-330]

`Omit.onProgressCapture`

#### Defined in [#defined-in-460]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2448

***

### onRateChange? [#onratechange]

> `optional` **onRateChange**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-331]

`Omit.onRateChange`

#### Defined in [#defined-in-461]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2449

***

### onRateChangeCapture? [#onratechangecapture]

> `optional` **onRateChangeCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-332]

`Omit.onRateChangeCapture`

#### Defined in [#defined-in-462]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2450

***

### onReset? [#onreset]

> `optional` **onReset**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-333]

`Omit.onReset`

#### Defined in [#defined-in-463]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2397

***

### onResetCapture? [#onresetcapture]

> `optional` **onResetCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-334]

`Omit.onResetCapture`

#### Defined in [#defined-in-464]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2398

***

### onScroll? [#onscroll]

> `optional` **onScroll**: `UIEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-335]

`Omit.onScroll`

#### Defined in [#defined-in-465]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2539

***

### onScrollCapture? [#onscrollcapture]

> `optional` **onScrollCapture**: `UIEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-336]

`Omit.onScrollCapture`

#### Defined in [#defined-in-466]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2540

***

### onScrollEnd? [#onscrollend]

> `optional` **onScrollEnd**: `UIEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-337]

`Omit.onScrollEnd`

#### Defined in [#defined-in-467]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2541

***

### onScrollEndCapture? [#onscrollendcapture]

> `optional` **onScrollEndCapture**: `UIEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-338]

`Omit.onScrollEndCapture`

#### Defined in [#defined-in-468]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2542

***

### onSeeked? [#onseeked]

> `optional` **onSeeked**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-339]

`Omit.onSeeked`

#### Defined in [#defined-in-469]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2451

***

### onSeekedCapture? [#onseekedcapture]

> `optional` **onSeekedCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-340]

`Omit.onSeekedCapture`

#### Defined in [#defined-in-470]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2452

***

### onSeeking? [#onseeking]

> `optional` **onSeeking**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-341]

`Omit.onSeeking`

#### Defined in [#defined-in-471]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2453

***

### onSeekingCapture? [#onseekingcapture]

> `optional` **onSeekingCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-342]

`Omit.onSeekingCapture`

#### Defined in [#defined-in-472]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2454

***

### onSelect? [#onselect]

> `optional` **onSelect**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-343]

`Omit.onSelect`

#### Defined in [#defined-in-473]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2505

***

### onSelectCapture? [#onselectcapture]

> `optional` **onSelectCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-344]

`Omit.onSelectCapture`

#### Defined in [#defined-in-474]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2506

***

### onStalled? [#onstalled]

> `optional` **onStalled**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-345]

`Omit.onStalled`

#### Defined in [#defined-in-475]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2455

***

### onStalledCapture? [#onstalledcapture]

> `optional` **onStalledCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-346]

`Omit.onStalledCapture`

#### Defined in [#defined-in-476]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2456

***

### onSubmit? [#onsubmit]

> `optional` **onSubmit**: `SubmitEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-347]

`Omit.onSubmit`

#### Defined in [#defined-in-477]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2399

***

### onSubmitCapture? [#onsubmitcapture]

> `optional` **onSubmitCapture**: `SubmitEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-348]

`Omit.onSubmitCapture`

#### Defined in [#defined-in-478]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2400

***

### onSuspend? [#onsuspend]

> `optional` **onSuspend**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-349]

`Omit.onSuspend`

#### Defined in [#defined-in-479]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2457

***

### onSuspendCapture? [#onsuspendcapture]

> `optional` **onSuspendCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-350]

`Omit.onSuspendCapture`

#### Defined in [#defined-in-480]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2458

***

### onTimeUpdate? [#ontimeupdate]

> `optional` **onTimeUpdate**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-351]

`Omit.onTimeUpdate`

#### Defined in [#defined-in-481]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2459

***

### onTimeUpdateCapture? [#ontimeupdatecapture]

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-352]

`Omit.onTimeUpdateCapture`

#### Defined in [#defined-in-482]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2460

***

### onToggle? [#ontoggle]

> `optional` **onToggle**: `ToggleEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-353]

`Omit.onToggle`

#### Defined in [#defined-in-483]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2557

***

### onTouchCancel? [#ontouchcancel]

> `optional` **onTouchCancel**: `TouchEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-354]

`Omit.onTouchCancel`

#### Defined in [#defined-in-484]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2509

***

### onTouchCancelCapture? [#ontouchcancelcapture]

> `optional` **onTouchCancelCapture**: `TouchEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-355]

`Omit.onTouchCancelCapture`

#### Defined in [#defined-in-485]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2510

***

### onTouchEnd? [#ontouchend]

> `optional` **onTouchEnd**: `TouchEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-356]

`Omit.onTouchEnd`

#### Defined in [#defined-in-486]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2511

***

### onTouchEndCapture? [#ontouchendcapture]

> `optional` **onTouchEndCapture**: `TouchEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-357]

`Omit.onTouchEndCapture`

#### Defined in [#defined-in-487]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2512

***

### onTouchMove? [#ontouchmove]

> `optional` **onTouchMove**: `TouchEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-358]

`Omit.onTouchMove`

#### Defined in [#defined-in-488]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2513

***

### onTouchMoveCapture? [#ontouchmovecapture]

> `optional` **onTouchMoveCapture**: `TouchEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-359]

`Omit.onTouchMoveCapture`

#### Defined in [#defined-in-489]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2514

***

### onTouchStart? [#ontouchstart]

> `optional` **onTouchStart**: `TouchEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-360]

`Omit.onTouchStart`

#### Defined in [#defined-in-490]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2515

***

### onTouchStartCapture? [#ontouchstartcapture]

> `optional` **onTouchStartCapture**: `TouchEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-361]

`Omit.onTouchStartCapture`

#### Defined in [#defined-in-491]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2516

***

### onTransitionCancel? [#ontransitioncancel]

> `optional` **onTransitionCancel**: `TransitionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-362]

`Omit.onTransitionCancel`

#### Defined in [#defined-in-492]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2561

***

### onTransitionCancelCapture? [#ontransitioncancelcapture]

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-363]

`Omit.onTransitionCancelCapture`

#### Defined in [#defined-in-493]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2562

***

### onTransitionEnd? [#ontransitionend]

> `optional` **onTransitionEnd**: `TransitionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-364]

`Omit.onTransitionEnd`

#### Defined in [#defined-in-494]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2563

***

### onTransitionEndCapture? [#ontransitionendcapture]

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-365]

`Omit.onTransitionEndCapture`

#### Defined in [#defined-in-495]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2564

***

### onTransitionRun? [#ontransitionrun]

> `optional` **onTransitionRun**: `TransitionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-366]

`Omit.onTransitionRun`

#### Defined in [#defined-in-496]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2565

***

### onTransitionRunCapture? [#ontransitionruncapture]

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-367]

`Omit.onTransitionRunCapture`

#### Defined in [#defined-in-497]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2566

***

### onTransitionStart? [#ontransitionstart]

> `optional` **onTransitionStart**: `TransitionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-368]

`Omit.onTransitionStart`

#### Defined in [#defined-in-498]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2567

***

### onTransitionStartCapture? [#ontransitionstartcapture]

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-369]

`Omit.onTransitionStartCapture`

#### Defined in [#defined-in-499]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2568

***

### onVolumeChange? [#onvolumechange]

> `optional` **onVolumeChange**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-370]

`Omit.onVolumeChange`

#### Defined in [#defined-in-500]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2461

***

### onVolumeChangeCapture? [#onvolumechangecapture]

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-371]

`Omit.onVolumeChangeCapture`

#### Defined in [#defined-in-501]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2462

***

### onWaiting? [#onwaiting]

> `optional` **onWaiting**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-372]

`Omit.onWaiting`

#### Defined in [#defined-in-502]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2463

***

### onWaitingCapture? [#onwaitingcapture]

> `optional` **onWaitingCapture**: `ReactEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-373]

`Omit.onWaitingCapture`

#### Defined in [#defined-in-503]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2464

***

### onWheel? [#onwheel]

> `optional` **onWheel**: `WheelEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-374]

`Omit.onWheel`

#### Defined in [#defined-in-504]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2545

***

### onWheelCapture? [#onwheelcapture]

> `optional` **onWheelCapture**: `WheelEventHandler`\<`SVGSVGElement`>

#### Inherited from [#inherited-from-375]

`Omit.onWheelCapture`

#### Defined in [#defined-in-505]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2546

***

### opacity? [#opacity]

> `optional` **opacity**: `string` | `number`

#### Inherited from [#inherited-from-376]

`Omit.opacity`

#### Defined in [#defined-in-506]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3865

***

### operator? [#operator]

> `optional` **operator**: `string` | `number`

#### Inherited from [#inherited-from-377]

`Omit.operator`

#### Defined in [#defined-in-507]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3866

***

### order? [#order]

> `optional` **order**: `string` | `number`

#### Inherited from [#inherited-from-378]

`Omit.order`

#### Defined in [#defined-in-508]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3867

***

### orient? [#orient]

> `optional` **orient**: `string` | `number`

#### Inherited from [#inherited-from-379]

`Omit.orient`

#### Defined in [#defined-in-509]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3868

***

### orientation? [#orientation]

> `optional` **orientation**: `string` | `number`

#### Inherited from [#inherited-from-380]

`Omit.orientation`

#### Defined in [#defined-in-510]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3869

***

### origin? [#origin]

> `optional` **origin**: `string` | `number`

#### Inherited from [#inherited-from-381]

`Omit.origin`

#### Defined in [#defined-in-511]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3870

***

### overflow? [#overflow]

> `optional` **overflow**: `string` | `number`

#### Inherited from [#inherited-from-382]

`Omit.overflow`

#### Defined in [#defined-in-512]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3871

***

### overlinePosition? [#overlineposition]

> `optional` **overlinePosition**: `string` | `number`

#### Inherited from [#inherited-from-383]

`Omit.overlinePosition`

#### Defined in [#defined-in-513]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3872

***

### overlineThickness? [#overlinethickness]

> `optional` **overlineThickness**: `string` | `number`

#### Inherited from [#inherited-from-384]

`Omit.overlineThickness`

#### Defined in [#defined-in-514]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3873

***

### paintOrder? [#paintorder]

> `optional` **paintOrder**: `string` | `number`

#### Inherited from [#inherited-from-385]

`Omit.paintOrder`

#### Defined in [#defined-in-515]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3874

***

### panose1? [#panose1]

> `optional` **panose1**: `string` | `number`

#### Inherited from [#inherited-from-386]

`Omit.panose1`

#### Defined in [#defined-in-516]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3875

***

### part? [#part]

> `optional` **part**: `string`

#### Inherited from [#inherited-from-387]

`Omit.part`

#### Defined in [#defined-in-517]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3705

***

### path? [#path]

> `optional` **path**: `string`

#### Inherited from [#inherited-from-388]

`Omit.path`

#### Defined in [#defined-in-518]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3876

***

### pathLength? [#pathlength]

> `optional` **pathLength**: `string` | `number`

#### Inherited from [#inherited-from-389]

`Omit.pathLength`

#### Defined in [#defined-in-519]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3877

***

### patternContentUnits? [#patterncontentunits]

> `optional` **patternContentUnits**: `string`

#### Inherited from [#inherited-from-390]

`Omit.patternContentUnits`

#### Defined in [#defined-in-520]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3878

***

### patternTransform? [#patterntransform]

> `optional` **patternTransform**: `string` | `number`

#### Inherited from [#inherited-from-391]

`Omit.patternTransform`

#### Defined in [#defined-in-521]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3879

***

### patternUnits? [#patternunits]

> `optional` **patternUnits**: `string`

#### Inherited from [#inherited-from-392]

`Omit.patternUnits`

#### Defined in [#defined-in-522]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3880

***

### pointerEvents? [#pointerevents]

> `optional` **pointerEvents**: `string` | `number`

#### Inherited from [#inherited-from-393]

`Omit.pointerEvents`

#### Defined in [#defined-in-523]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3881

***

### points? [#points]

> `optional` **points**: `string`

#### Inherited from [#inherited-from-394]

`Omit.points`

#### Defined in [#defined-in-524]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3882

***

### pointsAtX? [#pointsatx]

> `optional` **pointsAtX**: `string` | `number`

#### Inherited from [#inherited-from-395]

`Omit.pointsAtX`

#### Defined in [#defined-in-525]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3883

***

### pointsAtY? [#pointsaty]

> `optional` **pointsAtY**: `string` | `number`

#### Inherited from [#inherited-from-396]

`Omit.pointsAtY`

#### Defined in [#defined-in-526]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3884

***

### pointsAtZ? [#pointsatz]

> `optional` **pointsAtZ**: `string` | `number`

#### Inherited from [#inherited-from-397]

`Omit.pointsAtZ`

#### Defined in [#defined-in-527]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3885

***

### preserveAlpha? [#preservealpha]

> `optional` **preserveAlpha**: `Booleanish`

#### Inherited from [#inherited-from-398]

`Omit.preserveAlpha`

#### Defined in [#defined-in-528]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3886

***

### preserveAspectRatio? [#preserveaspectratio]

> `optional` **preserveAspectRatio**: `string`

#### Inherited from [#inherited-from-399]

`Omit.preserveAspectRatio`

#### Defined in [#defined-in-529]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3887

***

### primitiveUnits? [#primitiveunits]

> `optional` **primitiveUnits**: `string` | `number`

#### Inherited from [#inherited-from-400]

`Omit.primitiveUnits`

#### Defined in [#defined-in-530]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3888

***

### r? [#r]

> `optional` **r**: `string` | `number`

#### Inherited from [#inherited-from-401]

`Omit.r`

#### Defined in [#defined-in-531]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3889

***

### radius? [#radius]

> `optional` **radius**: `string` | `number`

#### Inherited from [#inherited-from-402]

`Omit.radius`

#### Defined in [#defined-in-532]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3890

***

### ref? [#ref]

> `optional` **ref**: `Ref`\<`SVGSVGElement`>

Allows getting a ref to the component instance.
Once the component unmounts, React will set `ref.current` to `null`
(or call the ref with `null` if you passed a callback ref).

#### See [#see-32]

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from [#inherited-from-403]

`Omit.ref`

#### Defined in [#defined-in-533]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:301

***

### refX? [#refx]

> `optional` **refX**: `string` | `number`

#### Inherited from [#inherited-from-404]

`Omit.refX`

#### Defined in [#defined-in-534]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3891

***

### refY? [#refy]

> `optional` **refY**: `string` | `number`

#### Inherited from [#inherited-from-405]

`Omit.refY`

#### Defined in [#defined-in-535]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3892

***

### renderingIntent? [#renderingintent]

> `optional` **renderingIntent**: `string` | `number`

#### Inherited from [#inherited-from-406]

`Omit.renderingIntent`

#### Defined in [#defined-in-536]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3893

***

### repeatCount? [#repeatcount]

> `optional` **repeatCount**: `string` | `number`

#### Inherited from [#inherited-from-407]

`Omit.repeatCount`

#### Defined in [#defined-in-537]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3894

***

### repeatDur? [#repeatdur]

> `optional` **repeatDur**: `string` | `number`

#### Inherited from [#inherited-from-408]

`Omit.repeatDur`

#### Defined in [#defined-in-538]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3895

***

### requiredExtensions? [#requiredextensions]

> `optional` **requiredExtensions**: `string` | `number`

#### Inherited from [#inherited-from-409]

`Omit.requiredExtensions`

#### Defined in [#defined-in-539]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3896

***

### requiredFeatures? [#requiredfeatures]

> `optional` **requiredFeatures**: `string` | `number`

#### Inherited from [#inherited-from-410]

`Omit.requiredFeatures`

#### Defined in [#defined-in-540]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3897

***

### restart? [#restart]

> `optional` **restart**: `string` | `number`

#### Inherited from [#inherited-from-411]

`Omit.restart`

#### Defined in [#defined-in-541]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3898

***

### result? [#result]

> `optional` **result**: `string`

#### Inherited from [#inherited-from-412]

`Omit.result`

#### Defined in [#defined-in-542]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3899

***

### role? [#role-1]

> `optional` **role**: `AriaRole`

#### Inherited from [#inherited-from-413]

`Omit.role`

#### Defined in [#defined-in-543]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3713

***

### rotate? [#rotate]

> `optional` **rotate**: `string` | `number`

#### Inherited from [#inherited-from-414]

`Omit.rotate`

#### Defined in [#defined-in-544]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3900

***

### rx? [#rx]

> `optional` **rx**: `string` | `number`

#### Inherited from [#inherited-from-415]

`Omit.rx`

#### Defined in [#defined-in-545]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3901

***

### ry? [#ry]

> `optional` **ry**: `string` | `number`

#### Inherited from [#inherited-from-416]

`Omit.ry`

#### Defined in [#defined-in-546]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3902

***

### scale? [#scale]

> `optional` **scale**: `string` | `number`

#### Inherited from [#inherited-from-417]

`Omit.scale`

#### Defined in [#defined-in-547]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3903

***

### seed? [#seed]

> `optional` **seed**: `string` | `number`

#### Inherited from [#inherited-from-418]

`Omit.seed`

#### Defined in [#defined-in-548]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3904

***

### shapeRendering? [#shaperendering]

> `optional` **shapeRendering**: `string` | `number`

#### Inherited from [#inherited-from-419]

`Omit.shapeRendering`

#### Defined in [#defined-in-549]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3905

***

### size? [#size]

> `optional` **size**: `string` | `number`

#### Defined in [#defined-in-550]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/Mark.tsx:12](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/Mark.tsx#L12)

***

### slope? [#slope]

> `optional` **slope**: `string` | `number`

#### Inherited from [#inherited-from-420]

`Omit.slope`

#### Defined in [#defined-in-551]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3906

***

### slot? [#slot]

> `optional` **slot**: `string`

#### Inherited from [#inherited-from-421]

`Omit.slot`

#### Defined in [#defined-in-552]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3706

***

### spacing? [#spacing]

> `optional` **spacing**: `string` | `number`

#### Inherited from [#inherited-from-422]

`Omit.spacing`

#### Defined in [#defined-in-553]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3907

***

### specularConstant? [#specularconstant]

> `optional` **specularConstant**: `string` | `number`

#### Inherited from [#inherited-from-423]

`Omit.specularConstant`

#### Defined in [#defined-in-554]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3908

***

### specularExponent? [#specularexponent]

> `optional` **specularExponent**: `string` | `number`

#### Inherited from [#inherited-from-424]

`Omit.specularExponent`

#### Defined in [#defined-in-555]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3909

***

### speed? [#speed]

> `optional` **speed**: `string` | `number`

#### Inherited from [#inherited-from-425]

`Omit.speed`

#### Defined in [#defined-in-556]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3910

***

### spreadMethod? [#spreadmethod]

> `optional` **spreadMethod**: `string`

#### Inherited from [#inherited-from-426]

`Omit.spreadMethod`

#### Defined in [#defined-in-557]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3911

***

### startOffset? [#startoffset]

> `optional` **startOffset**: `string` | `number`

#### Inherited from [#inherited-from-427]

`Omit.startOffset`

#### Defined in [#defined-in-558]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3912

***

### stdDeviation? [#stddeviation]

> `optional` **stdDeviation**: `string` | `number`

#### Inherited from [#inherited-from-428]

`Omit.stdDeviation`

#### Defined in [#defined-in-559]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3913

***

### stemh? [#stemh]

> `optional` **stemh**: `string` | `number`

#### Inherited from [#inherited-from-429]

`Omit.stemh`

#### Defined in [#defined-in-560]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3914

***

### stemv? [#stemv]

> `optional` **stemv**: `string` | `number`

#### Inherited from [#inherited-from-430]

`Omit.stemv`

#### Defined in [#defined-in-561]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3915

***

### stitchTiles? [#stitchtiles]

> `optional` **stitchTiles**: `string` | `number`

#### Inherited from [#inherited-from-431]

`Omit.stitchTiles`

#### Defined in [#defined-in-562]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3916

***

### stopColor? [#stopcolor]

> `optional` **stopColor**: `string`

#### Inherited from [#inherited-from-432]

`Omit.stopColor`

#### Defined in [#defined-in-563]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3917

***

### stopOpacity? [#stopopacity]

> `optional` **stopOpacity**: `string` | `number`

#### Inherited from [#inherited-from-433]

`Omit.stopOpacity`

#### Defined in [#defined-in-564]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3918

***

### strikethroughPosition? [#strikethroughposition]

> `optional` **strikethroughPosition**: `string` | `number`

#### Inherited from [#inherited-from-434]

`Omit.strikethroughPosition`

#### Defined in [#defined-in-565]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3919

***

### strikethroughThickness? [#strikethroughthickness]

> `optional` **strikethroughThickness**: `string` | `number`

#### Inherited from [#inherited-from-435]

`Omit.strikethroughThickness`

#### Defined in [#defined-in-566]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3920

***

### string? [#string]

> `optional` **string**: `string` | `number`

#### Inherited from [#inherited-from-436]

`Omit.string`

#### Defined in [#defined-in-567]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3921

***

### stroke? [#stroke]

> `optional` **stroke**: `string`

#### Inherited from [#inherited-from-437]

`Omit.stroke`

#### Defined in [#defined-in-568]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3922

***

### strokeDasharray? [#strokedasharray]

> `optional` **strokeDasharray**: `string` | `number`

#### Inherited from [#inherited-from-438]

`Omit.strokeDasharray`

#### Defined in [#defined-in-569]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3923

***

### strokeDashoffset? [#strokedashoffset]

> `optional` **strokeDashoffset**: `string` | `number`

#### Inherited from [#inherited-from-439]

`Omit.strokeDashoffset`

#### Defined in [#defined-in-570]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3924

***

### strokeLinecap? [#strokelinecap]

> `optional` **strokeLinecap**: `"inherit"` | `"butt"` | `"round"` | `"square"`

#### Inherited from [#inherited-from-440]

`Omit.strokeLinecap`

#### Defined in [#defined-in-571]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3925

***

### strokeLinejoin? [#strokelinejoin]

> `optional` **strokeLinejoin**: `"inherit"` | `"round"` | `"miter"` | `"bevel"`

#### Inherited from [#inherited-from-441]

`Omit.strokeLinejoin`

#### Defined in [#defined-in-572]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3926

***

### strokeMiterlimit? [#strokemiterlimit]

> `optional` **strokeMiterlimit**: `string` | `number`

#### Inherited from [#inherited-from-442]

`Omit.strokeMiterlimit`

#### Defined in [#defined-in-573]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3927

***

### strokeOpacity? [#strokeopacity]

> `optional` **strokeOpacity**: `string` | `number`

#### Inherited from [#inherited-from-443]

`Omit.strokeOpacity`

#### Defined in [#defined-in-574]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3928

***

### strokeWidth? [#strokewidth]

> `optional` **strokeWidth**: `string` | `number`

#### Inherited from [#inherited-from-444]

`Omit.strokeWidth`

#### Defined in [#defined-in-575]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3929

***

### style? [#style-1]

> `optional` **style**: `CSSProperties`

#### Inherited from [#inherited-from-445]

`Omit.style`

#### Defined in [#defined-in-576]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3707

***

### suppressHydrationWarning? [#suppresshydrationwarning]

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from [#inherited-from-446]

`Omit.suppressHydrationWarning`

#### Defined in [#defined-in-577]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3690

***

### surfaceScale? [#surfacescale]

> `optional` **surfaceScale**: `string` | `number`

#### Inherited from [#inherited-from-447]

`Omit.surfaceScale`

#### Defined in [#defined-in-578]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3930

***

### systemLanguage? [#systemlanguage]

> `optional` **systemLanguage**: `string` | `number`

#### Inherited from [#inherited-from-448]

`Omit.systemLanguage`

#### Defined in [#defined-in-579]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3931

***

### tabIndex? [#tabindex]

> `optional` **tabIndex**: `number`

#### Inherited from [#inherited-from-449]

`Omit.tabIndex`

#### Defined in [#defined-in-580]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3714

***

### tableValues? [#tablevalues]

> `optional` **tableValues**: `string` | `number`

#### Inherited from [#inherited-from-450]

`Omit.tableValues`

#### Defined in [#defined-in-581]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3932

***

### target? [#target]

> `optional` **target**: `string`

#### Inherited from [#inherited-from-451]

`Omit.target`

#### Defined in [#defined-in-582]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3708

***

### targetX? [#targetx]

> `optional` **targetX**: `string` | `number`

#### Inherited from [#inherited-from-452]

`Omit.targetX`

#### Defined in [#defined-in-583]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3933

***

### targetY? [#targety]

> `optional` **targetY**: `string` | `number`

#### Inherited from [#inherited-from-453]

`Omit.targetY`

#### Defined in [#defined-in-584]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3934

***

### textAnchor? [#textanchor]

> `optional` **textAnchor**: `"inherit"` | `"end"` | `"middle"` | `"start"`

#### Inherited from [#inherited-from-454]

`Omit.textAnchor`

#### Defined in [#defined-in-585]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3935

***

### textDecoration? [#textdecoration]

> `optional` **textDecoration**: `string` | `number`

#### Inherited from [#inherited-from-455]

`Omit.textDecoration`

#### Defined in [#defined-in-586]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3936

***

### textLength? [#textlength]

> `optional` **textLength**: `string` | `number`

#### Inherited from [#inherited-from-456]

`Omit.textLength`

#### Defined in [#defined-in-587]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3937

***

### textRendering? [#textrendering]

> `optional` **textRendering**: `string` | `number`

#### Inherited from [#inherited-from-457]

`Omit.textRendering`

#### Defined in [#defined-in-588]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3938

***

### to? [#to]

> `optional` **to**: `string` | `number`

#### Inherited from [#inherited-from-458]

`Omit.to`

#### Defined in [#defined-in-589]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3939

***

### transform? [#transform]

> `optional` **transform**: `string`

#### Inherited from [#inherited-from-459]

`Omit.transform`

#### Defined in [#defined-in-590]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3940

***

### type? [#type]

> `optional` **type**: `string`

#### Inherited from [#inherited-from-460]

`Omit.type`

#### Defined in [#defined-in-591]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3709

***

### u1? [#u1]

> `optional` **u1**: `string` | `number`

#### Inherited from [#inherited-from-461]

`Omit.u1`

#### Defined in [#defined-in-592]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3941

***

### u2? [#u2]

> `optional` **u2**: `string` | `number`

#### Inherited from [#inherited-from-462]

`Omit.u2`

#### Defined in [#defined-in-593]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3942

***

### underlinePosition? [#underlineposition]

> `optional` **underlinePosition**: `string` | `number`

#### Inherited from [#inherited-from-463]

`Omit.underlinePosition`

#### Defined in [#defined-in-594]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3943

***

### underlineThickness? [#underlinethickness]

> `optional` **underlineThickness**: `string` | `number`

#### Inherited from [#inherited-from-464]

`Omit.underlineThickness`

#### Defined in [#defined-in-595]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3944

***

### unicode? [#unicode]

> `optional` **unicode**: `string` | `number`

#### Inherited from [#inherited-from-465]

`Omit.unicode`

#### Defined in [#defined-in-596]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3945

***

### unicodeBidi? [#unicodebidi]

> `optional` **unicodeBidi**: `string` | `number`

#### Inherited from [#inherited-from-466]

`Omit.unicodeBidi`

#### Defined in [#defined-in-597]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3946

***

### unicodeRange? [#unicoderange]

> `optional` **unicodeRange**: `string` | `number`

#### Inherited from [#inherited-from-467]

`Omit.unicodeRange`

#### Defined in [#defined-in-598]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3947

***

### unitsPerEm? [#unitsperem]

> `optional` **unitsPerEm**: `string` | `number`

#### Inherited from [#inherited-from-468]

`Omit.unitsPerEm`

#### Defined in [#defined-in-599]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3948

***

### vAlphabetic? [#valphabetic]

> `optional` **vAlphabetic**: `string` | `number`

#### Inherited from [#inherited-from-469]

`Omit.vAlphabetic`

#### Defined in [#defined-in-600]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3949

***

### values? [#values]

> `optional` **values**: `string`

#### Inherited from [#inherited-from-470]

`Omit.values`

#### Defined in [#defined-in-601]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3950

***

### vectorEffect? [#vectoreffect]

> `optional` **vectorEffect**: `string` | `number`

#### Inherited from [#inherited-from-471]

`Omit.vectorEffect`

#### Defined in [#defined-in-602]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3951

***

### version? [#version]

> `optional` **version**: `string`

#### Inherited from [#inherited-from-472]

`Omit.version`

#### Defined in [#defined-in-603]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3952

***

### vertAdvY? [#vertadvy]

> `optional` **vertAdvY**: `string` | `number`

#### Inherited from [#inherited-from-473]

`Omit.vertAdvY`

#### Defined in [#defined-in-604]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3953

***

### vertOriginX? [#vertoriginx]

> `optional` **vertOriginX**: `string` | `number`

#### Inherited from [#inherited-from-474]

`Omit.vertOriginX`

#### Defined in [#defined-in-605]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3954

***

### vertOriginY? [#vertoriginy]

> `optional` **vertOriginY**: `string` | `number`

#### Inherited from [#inherited-from-475]

`Omit.vertOriginY`

#### Defined in [#defined-in-606]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3955

***

### vHanging? [#vhanging]

> `optional` **vHanging**: `string` | `number`

#### Inherited from [#inherited-from-476]

`Omit.vHanging`

#### Defined in [#defined-in-607]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3956

***

### vIdeographic? [#videographic]

> `optional` **vIdeographic**: `string` | `number`

#### Inherited from [#inherited-from-477]

`Omit.vIdeographic`

#### Defined in [#defined-in-608]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3957

***

### viewBox? [#viewbox]

> `optional` **viewBox**: `string`

#### Inherited from [#inherited-from-478]

`Omit.viewBox`

#### Defined in [#defined-in-609]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3958

***

### viewTarget? [#viewtarget]

> `optional` **viewTarget**: `string` | `number`

#### Inherited from [#inherited-from-479]

`Omit.viewTarget`

#### Defined in [#defined-in-610]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3959

***

### visibility? [#visibility]

> `optional` **visibility**: `string` | `number`

#### Inherited from [#inherited-from-480]

`Omit.visibility`

#### Defined in [#defined-in-611]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3960

***

### vMathematical? [#vmathematical]

> `optional` **vMathematical**: `string` | `number`

#### Inherited from [#inherited-from-481]

`Omit.vMathematical`

#### Defined in [#defined-in-612]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3961

***

### width? [#width]

> `optional` **width**: `string` | `number`

#### Inherited from [#inherited-from-482]

`Omit.width`

#### Defined in [#defined-in-613]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3710

***

### widths? [#widths]

> `optional` **widths**: `string` | `number`

#### Inherited from [#inherited-from-483]

`Omit.widths`

#### Defined in [#defined-in-614]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3962

***

### wordSpacing? [#wordspacing]

> `optional` **wordSpacing**: `string` | `number`

#### Inherited from [#inherited-from-484]

`Omit.wordSpacing`

#### Defined in [#defined-in-615]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3963

***

### writingMode? [#writingmode]

> `optional` **writingMode**: `string` | `number`

#### Inherited from [#inherited-from-485]

`Omit.writingMode`

#### Defined in [#defined-in-616]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3964

***

### x? [#x]

> `optional` **x**: `string` | `number`

#### Inherited from [#inherited-from-486]

`Omit.x`

#### Defined in [#defined-in-617]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3967

***

### x1? [#x1]

> `optional` **x1**: `string` | `number`

#### Inherited from [#inherited-from-487]

`Omit.x1`

#### Defined in [#defined-in-618]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3965

***

### x2? [#x2]

> `optional` **x2**: `string` | `number`

#### Inherited from [#inherited-from-488]

`Omit.x2`

#### Defined in [#defined-in-619]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3966

***

### xChannelSelector? [#xchannelselector]

> `optional` **xChannelSelector**: `string`

#### Inherited from [#inherited-from-489]

`Omit.xChannelSelector`

#### Defined in [#defined-in-620]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3968

***

### xHeight? [#xheight]

> `optional` **xHeight**: `string` | `number`

#### Inherited from [#inherited-from-490]

`Omit.xHeight`

#### Defined in [#defined-in-621]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3969

***

### xlinkActuate? [#xlinkactuate]

> `optional` **xlinkActuate**: `string`

#### Inherited from [#inherited-from-491]

`Omit.xlinkActuate`

#### Defined in [#defined-in-622]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3970

***

### xlinkArcrole? [#xlinkarcrole]

> `optional` **xlinkArcrole**: `string`

#### Inherited from [#inherited-from-492]

`Omit.xlinkArcrole`

#### Defined in [#defined-in-623]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3971

***

### xlinkHref? [#xlinkhref]

> `optional` **xlinkHref**: `string`

#### Inherited from [#inherited-from-493]

`Omit.xlinkHref`

#### Defined in [#defined-in-624]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3972

***

### xlinkRole? [#xlinkrole]

> `optional` **xlinkRole**: `string`

#### Inherited from [#inherited-from-494]

`Omit.xlinkRole`

#### Defined in [#defined-in-625]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3973

***

### xlinkShow? [#xlinkshow]

> `optional` **xlinkShow**: `string`

#### Inherited from [#inherited-from-495]

`Omit.xlinkShow`

#### Defined in [#defined-in-626]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3974

***

### xlinkTitle? [#xlinktitle]

> `optional` **xlinkTitle**: `string`

#### Inherited from [#inherited-from-496]

`Omit.xlinkTitle`

#### Defined in [#defined-in-627]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3975

***

### xlinkType? [#xlinktype]

> `optional` **xlinkType**: `string`

#### Inherited from [#inherited-from-497]

`Omit.xlinkType`

#### Defined in [#defined-in-628]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3976

***

### xmlBase? [#xmlbase]

> `optional` **xmlBase**: `string`

#### Inherited from [#inherited-from-498]

`Omit.xmlBase`

#### Defined in [#defined-in-629]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3977

***

### xmlLang? [#xmllang]

> `optional` **xmlLang**: `string`

#### Inherited from [#inherited-from-499]

`Omit.xmlLang`

#### Defined in [#defined-in-630]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3978

***

### xmlns? [#xmlns]

> `optional` **xmlns**: `string`

#### Inherited from [#inherited-from-500]

`Omit.xmlns`

#### Defined in [#defined-in-631]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3979

***

### xmlnsXlink? [#xmlnsxlink]

> `optional` **xmlnsXlink**: `string`

#### Inherited from [#inherited-from-501]

`Omit.xmlnsXlink`

#### Defined in [#defined-in-632]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3980

***

### xmlSpace? [#xmlspace]

> `optional` **xmlSpace**: `string`

#### Inherited from [#inherited-from-502]

`Omit.xmlSpace`

#### Defined in [#defined-in-633]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3981

***

### y? [#y]

> `optional` **y**: `string` | `number`

#### Inherited from [#inherited-from-503]

`Omit.y`

#### Defined in [#defined-in-634]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3984

***

### y1? [#y1]

> `optional` **y1**: `string` | `number`

#### Inherited from [#inherited-from-504]

`Omit.y1`

#### Defined in [#defined-in-635]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3982

***

### y2? [#y2]

> `optional` **y2**: `string` | `number`

#### Inherited from [#inherited-from-505]

`Omit.y2`

#### Defined in [#defined-in-636]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3983

***

### yChannelSelector? [#ychannelselector]

> `optional` **yChannelSelector**: `string`

#### Inherited from [#inherited-from-506]

`Omit.yChannelSelector`

#### Defined in [#defined-in-637]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3985

***

### z? [#z]

> `optional` **z**: `string` | `number`

#### Inherited from [#inherited-from-507]

`Omit.z`

#### Defined in [#defined-in-638]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3986

***

### zoomAndPan? [#zoomandpan]

> `optional` **zoomAndPan**: `string`

#### Inherited from [#inherited-from-508]

`Omit.zoomAndPan`

#### Defined in [#defined-in-639]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3987

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / SignInButtonProps

# Interface: SignInButtonProps [#interface-signinbuttonprops]

## Extends [#extends-4]

* `Omit`\<`ButtonProps`, `"onClick"` | `"children"` | `"variant"`>.[`AuthSignInOptions`](AuthSignInOptions.md)

## Properties [#properties-15]

### about? [#about]

> `optional` **about**: `string`

#### Inherited from [#inherited-from-509]

`Omit.about`

#### Defined in [#defined-in-640]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2914

***

### accessKey? [#accesskey]

> `optional` **accessKey**: `string`

#### Inherited from [#inherited-from-510]

`Omit.accessKey`

#### Defined in [#defined-in-641]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2887

***

### aria-activedescendant? [#aria-activedescendant-1]

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from [#inherited-from-511]

`Omit.aria-activedescendant`

#### Defined in [#defined-in-642]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2585

***

### aria-atomic? [#aria-atomic-1]

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from [#inherited-from-512]

`Omit.aria-atomic`

#### Defined in [#defined-in-643]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2587

***

### aria-autocomplete? [#aria-autocomplete-1]

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
presented if they are made.

#### Inherited from [#inherited-from-513]

`Omit.aria-autocomplete`

#### Defined in [#defined-in-644]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2592

***

### aria-braillelabel? [#aria-braillelabel-1]

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See [#see-33]

aria-label.

#### Inherited from [#inherited-from-514]

`Omit.aria-braillelabel`

#### Defined in [#defined-in-645]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2598

***

### aria-brailleroledescription? [#aria-brailleroledescription-1]

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See [#see-34]

aria-roledescription.

#### Inherited from [#inherited-from-515]

`Omit.aria-brailleroledescription`

#### Defined in [#defined-in-646]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2603

***

### aria-busy? [#aria-busy-1]

> `optional` **aria-busy**: `Booleanish`

#### Inherited from [#inherited-from-516]

`Omit.aria-busy`

#### Defined in [#defined-in-647]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2604

***

### aria-checked? [#aria-checked-1]

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See [#see-35]

* aria-pressed
* aria-selected.

#### Inherited from [#inherited-from-517]

`Omit.aria-checked`

#### Defined in [#defined-in-648]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2609

***

### aria-colcount? [#aria-colcount-1]

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See [#see-36]

aria-colindex.

#### Inherited from [#inherited-from-518]

`Omit.aria-colcount`

#### Defined in [#defined-in-649]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2614

***

### aria-colindex? [#aria-colindex-1]

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See [#see-37]

* aria-colcount
* aria-colspan.

#### Inherited from [#inherited-from-519]

`Omit.aria-colindex`

#### Defined in [#defined-in-650]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2619

***

### aria-colindextext? [#aria-colindextext-1]

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See [#see-38]

aria-rowindextext.

#### Inherited from [#inherited-from-520]

`Omit.aria-colindextext`

#### Defined in [#defined-in-651]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2624

***

### aria-colspan? [#aria-colspan-1]

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See [#see-39]

* aria-colindex
* aria-rowspan.

#### Inherited from [#inherited-from-521]

`Omit.aria-colspan`

#### Defined in [#defined-in-652]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2629

***

### aria-controls? [#aria-controls-1]

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See [#see-40]

aria-owns.

#### Inherited from [#inherited-from-522]

`Omit.aria-controls`

#### Defined in [#defined-in-653]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2634

***

### aria-current? [#aria-current-1]

> `optional` **aria-current**: `boolean` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"` | `"date"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from [#inherited-from-523]

`Omit.aria-current`

#### Defined in [#defined-in-654]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2636

***

### aria-describedby? [#aria-describedby-1]

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See [#see-41]

aria-labelledby

#### Inherited from [#inherited-from-524]

`Omit.aria-describedby`

#### Defined in [#defined-in-655]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2641

***

### aria-description? [#aria-description-1]

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See [#see-42]

related aria-describedby.

#### Inherited from [#inherited-from-525]

`Omit.aria-description`

#### Defined in [#defined-in-656]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2646

***

### aria-details? [#aria-details-1]

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See [#see-43]

aria-describedby.

#### Inherited from [#inherited-from-526]

`Omit.aria-details`

#### Defined in [#defined-in-657]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2651

***

### aria-disabled? [#aria-disabled-1]

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See [#see-44]

* aria-hidden
* aria-readonly.

#### Inherited from [#inherited-from-527]

`Omit.aria-disabled`

#### Defined in [#defined-in-658]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2656

***

### ~~aria-dropeffect?~~ [#aria-dropeffect-1]

> `optional` **aria-dropeffect**: `"none"` | `"link"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated [#deprecated-4]

in ARIA 1.1

#### Inherited from [#inherited-from-528]

`Omit.aria-dropeffect`

#### Defined in [#defined-in-659]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2661

***

### aria-errormessage? [#aria-errormessage-1]

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See [#see-45]

* aria-invalid
* aria-describedby.

#### Inherited from [#inherited-from-529]

`Omit.aria-errormessage`

#### Defined in [#defined-in-660]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2666

***

### aria-expanded? [#aria-expanded-1]

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from [#inherited-from-530]

`Omit.aria-expanded`

#### Defined in [#defined-in-661]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2668

***

### aria-flowto? [#aria-flowto-1]

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
allows assistive technology to override the general default of reading in document source order.

#### Inherited from [#inherited-from-531]

`Omit.aria-flowto`

#### Defined in [#defined-in-662]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2673

***

### ~~aria-grabbed?~~ [#aria-grabbed-1]

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated [#deprecated-5]

in ARIA 1.1

#### Inherited from [#inherited-from-532]

`Omit.aria-grabbed`

#### Defined in [#defined-in-663]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2678

***

### aria-haspopup? [#aria-haspopup-1]

> `optional` **aria-haspopup**: `boolean` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from [#inherited-from-533]

`Omit.aria-haspopup`

#### Defined in [#defined-in-664]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2680

***

### aria-hidden? [#aria-hidden-1]

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See [#see-46]

aria-disabled.

#### Inherited from [#inherited-from-534]

`Omit.aria-hidden`

#### Defined in [#defined-in-665]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2685

***

### aria-invalid? [#aria-invalid-1]

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See [#see-47]

aria-errormessage.

#### Inherited from [#inherited-from-535]

`Omit.aria-invalid`

#### Defined in [#defined-in-666]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2690

***

### aria-keyshortcuts? [#aria-keyshortcuts-1]

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from [#inherited-from-536]

`Omit.aria-keyshortcuts`

#### Defined in [#defined-in-667]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2692

***

### aria-label? [#aria-label-1]

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See [#see-48]

aria-labelledby.

#### Inherited from [#inherited-from-537]

`Omit.aria-label`

#### Defined in [#defined-in-668]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2697

***

### aria-labelledby? [#aria-labelledby-1]

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See [#see-49]

aria-describedby.

#### Inherited from [#inherited-from-538]

`Omit.aria-labelledby`

#### Defined in [#defined-in-669]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2702

***

### aria-level? [#aria-level-1]

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from [#inherited-from-539]

`Omit.aria-level`

#### Defined in [#defined-in-670]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2704

***

### aria-live? [#aria-live-1]

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from [#inherited-from-540]

`Omit.aria-live`

#### Defined in [#defined-in-671]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2706

***

### aria-modal? [#aria-modal-1]

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from [#inherited-from-541]

`Omit.aria-modal`

#### Defined in [#defined-in-672]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2708

***

### aria-multiline? [#aria-multiline-1]

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from [#inherited-from-542]

`Omit.aria-multiline`

#### Defined in [#defined-in-673]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2710

***

### aria-multiselectable? [#aria-multiselectable-1]

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from [#inherited-from-543]

`Omit.aria-multiselectable`

#### Defined in [#defined-in-674]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2712

***

### aria-orientation? [#aria-orientation-1]

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from [#inherited-from-544]

`Omit.aria-orientation`

#### Defined in [#defined-in-675]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2714

***

### aria-owns? [#aria-owns-1]

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See [#see-50]

aria-controls.

#### Inherited from [#inherited-from-545]

`Omit.aria-owns`

#### Defined in [#defined-in-676]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2720

***

### aria-placeholder? [#aria-placeholder-1]

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
A hint could be a sample value or a brief description of the expected format.

#### Inherited from [#inherited-from-546]

`Omit.aria-placeholder`

#### Defined in [#defined-in-677]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2725

***

### aria-posinset? [#aria-posinset-1]

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See [#see-51]

aria-setsize.

#### Inherited from [#inherited-from-547]

`Omit.aria-posinset`

#### Defined in [#defined-in-678]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2730

***

### aria-pressed? [#aria-pressed-1]

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See [#see-52]

* aria-checked
* aria-selected.

#### Inherited from [#inherited-from-548]

`Omit.aria-pressed`

#### Defined in [#defined-in-679]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2735

***

### aria-readonly? [#aria-readonly-1]

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See [#see-53]

aria-disabled.

#### Inherited from [#inherited-from-549]

`Omit.aria-readonly`

#### Defined in [#defined-in-680]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2740

***

### aria-relevant? [#aria-relevant-1]

> `optional` **aria-relevant**: `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"all"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See [#see-54]

aria-atomic.

#### Inherited from [#inherited-from-550]

`Omit.aria-relevant`

#### Defined in [#defined-in-681]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2745

***

### aria-required? [#aria-required-1]

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from [#inherited-from-551]

`Omit.aria-required`

#### Defined in [#defined-in-682]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2758

***

### aria-roledescription? [#aria-roledescription-1]

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from [#inherited-from-552]

`Omit.aria-roledescription`

#### Defined in [#defined-in-683]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2760

***

### aria-rowcount? [#aria-rowcount-1]

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See [#see-55]

aria-rowindex.

#### Inherited from [#inherited-from-553]

`Omit.aria-rowcount`

#### Defined in [#defined-in-684]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2765

***

### aria-rowindex? [#aria-rowindex-1]

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See [#see-56]

* aria-rowcount
* aria-rowspan.

#### Inherited from [#inherited-from-554]

`Omit.aria-rowindex`

#### Defined in [#defined-in-685]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2770

***

### aria-rowindextext? [#aria-rowindextext-1]

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See [#see-57]

aria-colindextext.

#### Inherited from [#inherited-from-555]

`Omit.aria-rowindextext`

#### Defined in [#defined-in-686]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2775

***

### aria-rowspan? [#aria-rowspan-1]

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See [#see-58]

* aria-rowindex
* aria-colspan.

#### Inherited from [#inherited-from-556]

`Omit.aria-rowspan`

#### Defined in [#defined-in-687]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2780

***

### aria-selected? [#aria-selected-1]

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See [#see-59]

* aria-checked
* aria-pressed.

#### Inherited from [#inherited-from-557]

`Omit.aria-selected`

#### Defined in [#defined-in-688]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2785

***

### aria-setsize? [#aria-setsize-1]

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See [#see-60]

aria-posinset.

#### Inherited from [#inherited-from-558]

`Omit.aria-setsize`

#### Defined in [#defined-in-689]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2790

***

### aria-sort? [#aria-sort-1]

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from [#inherited-from-559]

`Omit.aria-sort`

#### Defined in [#defined-in-690]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2792

***

### aria-valuemax? [#aria-valuemax-1]

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from [#inherited-from-560]

`Omit.aria-valuemax`

#### Defined in [#defined-in-691]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2794

***

### aria-valuemin? [#aria-valuemin-1]

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from [#inherited-from-561]

`Omit.aria-valuemin`

#### Defined in [#defined-in-692]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2796

***

### aria-valuenow? [#aria-valuenow-1]

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See [#see-61]

aria-valuetext.

#### Inherited from [#inherited-from-562]

`Omit.aria-valuenow`

#### Defined in [#defined-in-693]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2801

***

### aria-valuetext? [#aria-valuetext-1]

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from [#inherited-from-563]

`Omit.aria-valuetext`

#### Defined in [#defined-in-694]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2803

***

### asChild? [#aschild]

> `optional` **asChild**: `boolean`

#### Inherited from [#inherited-from-564]

`Omit.asChild`

#### Defined in [#defined-in-695]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/ui/button.tsx:48](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/ui/button.tsx#L48)

***

### autoCapitalize? [#autocapitalize]

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from [#inherited-from-565]

`Omit.autoCapitalize`

#### Defined in [#defined-in-696]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2888

***

### autoCorrect? [#autocorrect]

> `optional` **autoCorrect**: `string`

#### Inherited from [#inherited-from-566]

`Omit.autoCorrect`

#### Defined in [#defined-in-697]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2927

***

### autoFocus? [#autofocus]

> `optional` **autoFocus**: `boolean`

#### Inherited from [#inherited-from-567]

`Omit.autoFocus`

#### Defined in [#defined-in-698]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2889

***

### autoSave? [#autosave]

> `optional` **autoSave**: `string`

#### Inherited from [#inherited-from-568]

`Omit.autoSave`

#### Defined in [#defined-in-699]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2928

***

### busyLabel? [#busylabel]

> `optional` **busyLabel**: `ReactNode`

Shown while redirecting. Default "Redirecting...".

#### Defined in [#defined-in-700]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignInButton.tsx:31](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignInButton.tsx#L31)

***

### children? [#children-2]

> `optional` **children**: `ReactNode`

Label override. Default "Continue with Alternate Clouds".

#### Defined in [#defined-in-701]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignInButton.tsx:29](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignInButton.tsx#L29)

***

### className? [#classname-1]

> `optional` **className**: `string`

#### Inherited from [#inherited-from-569]

`Omit.className`

#### Defined in [#defined-in-702]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2890

***

### color? [#color-1]

> `optional` **color**: `string`

#### Inherited from [#inherited-from-570]

`Omit.color`

#### Defined in [#defined-in-703]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2929

***

### content? [#content]

> `optional` **content**: `string`

#### Inherited from [#inherited-from-571]

`Omit.content`

#### Defined in [#defined-in-704]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2915

***

### contentEditable? [#contenteditable]

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from [#inherited-from-572]

`Omit.contentEditable`

#### Defined in [#defined-in-705]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2891

***

### contextMenu? [#contextmenu]

> `optional` **contextMenu**: `string`

#### Inherited from [#inherited-from-573]

`Omit.contextMenu`

#### Defined in [#defined-in-706]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2892

***

### dangerouslySetInnerHTML? [#dangerouslysetinnerhtml-1]

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html [#__html-1]

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from [#inherited-from-574]

`Omit.dangerouslySetInnerHTML`

#### Defined in [#defined-in-707]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2362

***

### datatype? [#datatype]

> `optional` **datatype**: `string`

#### Inherited from [#inherited-from-575]

`Omit.datatype`

#### Defined in [#defined-in-708]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2916

***

### defaultChecked? [#defaultchecked]

> `optional` **defaultChecked**: `boolean`

#### Inherited from [#inherited-from-576]

`Omit.defaultChecked`

#### Defined in [#defined-in-709]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2881

***

### defaultValue? [#defaultvalue]

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from [#inherited-from-577]

`Omit.defaultValue`

#### Defined in [#defined-in-710]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2882

***

### dir? [#dir]

> `optional` **dir**: `string`

#### Inherited from [#inherited-from-578]

`Omit.dir`

#### Defined in [#defined-in-711]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2893

***

### disabled? [#disabled]

> `optional` **disabled**: `boolean`

#### Inherited from [#inherited-from-579]

`Omit.disabled`

#### Defined in [#defined-in-712]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3147

***

### draggable? [#draggable]

> `optional` **draggable**: `Booleanish`

#### Inherited from [#inherited-from-580]

`Omit.draggable`

#### Defined in [#defined-in-713]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2894

***

### enterKeyHint? [#enterkeyhint]

> `optional` **enterKeyHint**: `"search"` | `"enter"` | `"done"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from [#inherited-from-581]

`Omit.enterKeyHint`

#### Defined in [#defined-in-714]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2895

***

### exportparts? [#exportparts]

> `optional` **exportparts**: `string`

#### See [#see-62]

[https://developer.mozilla.org/en-US/docs/Web/HTML/Global\_attributes/exportparts](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts)

#### Inherited from [#inherited-from-582]

`Omit.exportparts`

#### Defined in [#defined-in-715]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2962

***

### form? [#form]

> `optional` **form**: `string`

#### Inherited from [#inherited-from-583]

`Omit.form`

#### Defined in [#defined-in-716]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3148

***

### formAction? [#formaction]

> `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`\<`void`>

#### Inherited from [#inherited-from-584]

`Omit.formAction`

#### Defined in [#defined-in-717]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3149

***

### formEncType? [#formenctype]

> `optional` **formEncType**: `string`

#### Inherited from [#inherited-from-585]

`Omit.formEncType`

#### Defined in [#defined-in-718]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3156

***

### formMethod? [#formmethod]

> `optional` **formMethod**: `string`

#### Inherited from [#inherited-from-586]

`Omit.formMethod`

#### Defined in [#defined-in-719]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3157

***

### formNoValidate? [#formnovalidate]

> `optional` **formNoValidate**: `boolean`

#### Inherited from [#inherited-from-587]

`Omit.formNoValidate`

#### Defined in [#defined-in-720]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3158

***

### formTarget? [#formtarget]

> `optional` **formTarget**: `string`

#### Inherited from [#inherited-from-588]

`Omit.formTarget`

#### Defined in [#defined-in-721]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3159

***

### hidden? [#hidden]

> `optional` **hidden**: `boolean`

#### Inherited from [#inherited-from-589]

`Omit.hidden`

#### Defined in [#defined-in-722]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2896

***

### hideMark? [#hidemark]

> `optional` **hideMark**: `boolean`

#### Defined in [#defined-in-723]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignInButton.tsx:33](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignInButton.tsx#L33)

***

### id? [#id-2]

> `optional` **id**: `string`

#### Inherited from [#inherited-from-590]

`Omit.id`

#### Defined in [#defined-in-724]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2897

***

### inert? [#inert]

> `optional` **inert**: `boolean`

#### See [#see-63]

[https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert)

#### Inherited from [#inherited-from-591]

`Omit.inert`

#### Defined in [#defined-in-725]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2948

***

### inlist? [#inlist]

> `optional` **inlist**: `any`

#### Inherited from [#inherited-from-592]

`Omit.inlist`

#### Defined in [#defined-in-726]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2917

***

### inputMode? [#inputmode]

> `optional` **inputMode**: `"none"` | `"email"` | `"search"` | `"text"` | `"tel"` | `"url"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See [#see-64]

[https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute)

#### Inherited from [#inherited-from-593]

`Omit.inputMode`

#### Defined in [#defined-in-727]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2953

***

### is? [#is]

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See [#see-65]

[https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is)

#### Inherited from [#inherited-from-594]

`Omit.is`

#### Defined in [#defined-in-728]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2958

***

### itemID? [#itemid]

> `optional` **itemID**: `string`

#### Inherited from [#inherited-from-595]

`Omit.itemID`

#### Defined in [#defined-in-729]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2933

***

### itemProp? [#itemprop]

> `optional` **itemProp**: `string`

#### Inherited from [#inherited-from-596]

`Omit.itemProp`

#### Defined in [#defined-in-730]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2930

***

### itemRef? [#itemref]

> `optional` **itemRef**: `string`

#### Inherited from [#inherited-from-597]

`Omit.itemRef`

#### Defined in [#defined-in-731]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2934

***

### itemScope? [#itemscope]

> `optional` **itemScope**: `boolean`

#### Inherited from [#inherited-from-598]

`Omit.itemScope`

#### Defined in [#defined-in-732]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2931

***

### itemType? [#itemtype]

> `optional` **itemType**: `string`

#### Inherited from [#inherited-from-599]

`Omit.itemType`

#### Defined in [#defined-in-733]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2932

***

### key? [#key-1]

> `optional` **key**: `null` | `Key`

#### Inherited from [#inherited-from-600]

`Omit.key`

#### Defined in [#defined-in-734]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:259

***

### lang? [#lang-1]

> `optional` **lang**: `string`

#### Inherited from [#inherited-from-601]

`Omit.lang`

#### Defined in [#defined-in-735]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2898

***

### loginHint? [#loginhint-1]

> `optional` **loginHint**: `string`

#### Inherited from [#inherited-from-602]

[`AuthSignInOptions`](AuthSignInOptions.md).[`loginHint`](AuthSignInOptions.md#loginhint)

#### Defined in [#defined-in-736]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:37](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L37)

***

### name? [#name-3]

> `optional` **name**: `string`

#### Inherited from [#inherited-from-603]

`Omit.name`

#### Defined in [#defined-in-737]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3160

***

### nonce? [#nonce-1]

> `optional` **nonce**: `string`

#### Inherited from [#inherited-from-604]

`Omit.nonce`

#### Defined in [#defined-in-738]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2899

***

### onAbort? [#onabort-1]

> `optional` **onAbort**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-605]

`Omit.onAbort`

#### Defined in [#defined-in-739]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2421

***

### onAbortCapture? [#onabortcapture-1]

> `optional` **onAbortCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-606]

`Omit.onAbortCapture`

#### Defined in [#defined-in-740]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2422

***

### onAnimationEnd? [#onanimationend-1]

> `optional` **onAnimationEnd**: `AnimationEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-607]

`Omit.onAnimationEnd`

#### Defined in [#defined-in-741]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2551

***

### onAnimationEndCapture? [#onanimationendcapture-1]

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-608]

`Omit.onAnimationEndCapture`

#### Defined in [#defined-in-742]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2552

***

### onAnimationIteration? [#onanimationiteration-1]

> `optional` **onAnimationIteration**: `AnimationEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-609]

`Omit.onAnimationIteration`

#### Defined in [#defined-in-743]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2553

***

### onAnimationIterationCapture? [#onanimationiterationcapture-1]

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-610]

`Omit.onAnimationIterationCapture`

#### Defined in [#defined-in-744]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2554

***

### onAnimationStart? [#onanimationstart-1]

> `optional` **onAnimationStart**: `AnimationEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-611]

`Omit.onAnimationStart`

#### Defined in [#defined-in-745]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2549

***

### onAnimationStartCapture? [#onanimationstartcapture-1]

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-612]

`Omit.onAnimationStartCapture`

#### Defined in [#defined-in-746]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2550

***

### onAuxClick? [#onauxclick-1]

> `optional` **onAuxClick**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-613]

`Omit.onAuxClick`

#### Defined in [#defined-in-747]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2467

***

### onAuxClickCapture? [#onauxclickcapture-1]

> `optional` **onAuxClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-614]

`Omit.onAuxClickCapture`

#### Defined in [#defined-in-748]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2468

***

### onBeforeInput? [#onbeforeinput-1]

> `optional` **onBeforeInput**: `InputEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-615]

`Omit.onBeforeInput`

#### Defined in [#defined-in-749]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2393

***

### onBeforeInputCapture? [#onbeforeinputcapture-1]

> `optional` **onBeforeInputCapture**: `InputEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-616]

`Omit.onBeforeInputCapture`

#### Defined in [#defined-in-750]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2394

***

### onBeforeToggle? [#onbeforetoggle-1]

> `optional` **onBeforeToggle**: `ToggleEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-617]

`Omit.onBeforeToggle`

#### Defined in [#defined-in-751]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2558

***

### onBlur? [#onblur-1]

> `optional` **onBlur**: `FocusEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-618]

`Omit.onBlur`

#### Defined in [#defined-in-752]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2387

***

### onBlurCapture? [#onblurcapture-1]

> `optional` **onBlurCapture**: `FocusEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-619]

`Omit.onBlurCapture`

#### Defined in [#defined-in-753]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2388

***

### onCanPlay? [#oncanplay-1]

> `optional` **onCanPlay**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-620]

`Omit.onCanPlay`

#### Defined in [#defined-in-754]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2423

***

### onCanPlayCapture? [#oncanplaycapture-1]

> `optional` **onCanPlayCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-621]

`Omit.onCanPlayCapture`

#### Defined in [#defined-in-755]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2424

***

### onCanPlayThrough? [#oncanplaythrough-1]

> `optional` **onCanPlayThrough**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-622]

`Omit.onCanPlayThrough`

#### Defined in [#defined-in-756]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2425

***

### onCanPlayThroughCapture? [#oncanplaythroughcapture-1]

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-623]

`Omit.onCanPlayThroughCapture`

#### Defined in [#defined-in-757]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2426

***

### onChange? [#onchange-1]

> `optional` **onChange**: `ChangeEventHandler`\<`HTMLButtonElement`, `Element`>

#### Inherited from [#inherited-from-624]

`Omit.onChange`

#### Defined in [#defined-in-758]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2391

***

### onChangeCapture? [#onchangecapture-1]

> `optional` **onChangeCapture**: `ChangeEventHandler`\<`HTMLButtonElement`, `Element`>

#### Inherited from [#inherited-from-625]

`Omit.onChangeCapture`

#### Defined in [#defined-in-759]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2392

***

### onClick()? [#onclick-1]

> `optional` **onClick**: (`event`) => `void`

#### Parameters [#parameters-51]

• **event**: `MouseEvent`\<`HTMLButtonElement`, `MouseEvent`>

#### Returns [#returns-66]

`void`

#### Defined in [#defined-in-760]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignInButton.tsx:32](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignInButton.tsx#L32)

***

### onClickCapture? [#onclickcapture-1]

> `optional` **onClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-626]

`Omit.onClickCapture`

#### Defined in [#defined-in-761]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2470

***

### onCompositionEnd? [#oncompositionend-1]

> `optional` **onCompositionEnd**: `CompositionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-627]

`Omit.onCompositionEnd`

#### Defined in [#defined-in-762]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2377

***

### onCompositionEndCapture? [#oncompositionendcapture-1]

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-628]

`Omit.onCompositionEndCapture`

#### Defined in [#defined-in-763]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2378

***

### onCompositionStart? [#oncompositionstart-1]

> `optional` **onCompositionStart**: `CompositionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-629]

`Omit.onCompositionStart`

#### Defined in [#defined-in-764]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2379

***

### onCompositionStartCapture? [#oncompositionstartcapture-1]

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-630]

`Omit.onCompositionStartCapture`

#### Defined in [#defined-in-765]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2380

***

### onCompositionUpdate? [#oncompositionupdate-1]

> `optional` **onCompositionUpdate**: `CompositionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-631]

`Omit.onCompositionUpdate`

#### Defined in [#defined-in-766]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2381

***

### onCompositionUpdateCapture? [#oncompositionupdatecapture-1]

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-632]

`Omit.onCompositionUpdateCapture`

#### Defined in [#defined-in-767]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2382

***

### onContextMenu? [#oncontextmenu-1]

> `optional` **onContextMenu**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-633]

`Omit.onContextMenu`

#### Defined in [#defined-in-768]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2471

***

### onContextMenuCapture? [#oncontextmenucapture-1]

> `optional` **onContextMenuCapture**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-634]

`Omit.onContextMenuCapture`

#### Defined in [#defined-in-769]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2472

***

### onCopy? [#oncopy-1]

> `optional` **onCopy**: `ClipboardEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-635]

`Omit.onCopy`

#### Defined in [#defined-in-770]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2369

***

### onCopyCapture? [#oncopycapture-1]

> `optional` **onCopyCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-636]

`Omit.onCopyCapture`

#### Defined in [#defined-in-771]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2370

***

### onCut? [#oncut-1]

> `optional` **onCut**: `ClipboardEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-637]

`Omit.onCut`

#### Defined in [#defined-in-772]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2371

***

### onCutCapture? [#oncutcapture-1]

> `optional` **onCutCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-638]

`Omit.onCutCapture`

#### Defined in [#defined-in-773]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2372

***

### onDoubleClick? [#ondoubleclick-1]

> `optional` **onDoubleClick**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-639]

`Omit.onDoubleClick`

#### Defined in [#defined-in-774]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2473

***

### onDoubleClickCapture? [#ondoubleclickcapture-1]

> `optional` **onDoubleClickCapture**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-640]

`Omit.onDoubleClickCapture`

#### Defined in [#defined-in-775]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2474

***

### onDrag? [#ondrag-1]

> `optional` **onDrag**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-641]

`Omit.onDrag`

#### Defined in [#defined-in-776]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2475

***

### onDragCapture? [#ondragcapture-1]

> `optional` **onDragCapture**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-642]

`Omit.onDragCapture`

#### Defined in [#defined-in-777]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2476

***

### onDragEnd? [#ondragend-1]

> `optional` **onDragEnd**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-643]

`Omit.onDragEnd`

#### Defined in [#defined-in-778]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2477

***

### onDragEndCapture? [#ondragendcapture-1]

> `optional` **onDragEndCapture**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-644]

`Omit.onDragEndCapture`

#### Defined in [#defined-in-779]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2478

***

### onDragEnter? [#ondragenter-1]

> `optional` **onDragEnter**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-645]

`Omit.onDragEnter`

#### Defined in [#defined-in-780]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2479

***

### onDragEnterCapture? [#ondragentercapture-1]

> `optional` **onDragEnterCapture**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-646]

`Omit.onDragEnterCapture`

#### Defined in [#defined-in-781]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2480

***

### onDragExit? [#ondragexit-1]

> `optional` **onDragExit**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-647]

`Omit.onDragExit`

#### Defined in [#defined-in-782]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2481

***

### onDragExitCapture? [#ondragexitcapture-1]

> `optional` **onDragExitCapture**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-648]

`Omit.onDragExitCapture`

#### Defined in [#defined-in-783]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2482

***

### onDragLeave? [#ondragleave-1]

> `optional` **onDragLeave**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-649]

`Omit.onDragLeave`

#### Defined in [#defined-in-784]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2483

***

### onDragLeaveCapture? [#ondragleavecapture-1]

> `optional` **onDragLeaveCapture**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-650]

`Omit.onDragLeaveCapture`

#### Defined in [#defined-in-785]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2484

***

### onDragOver? [#ondragover-1]

> `optional` **onDragOver**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-651]

`Omit.onDragOver`

#### Defined in [#defined-in-786]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2485

***

### onDragOverCapture? [#ondragovercapture-1]

> `optional` **onDragOverCapture**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-652]

`Omit.onDragOverCapture`

#### Defined in [#defined-in-787]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2486

***

### onDragStart? [#ondragstart-1]

> `optional` **onDragStart**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-653]

`Omit.onDragStart`

#### Defined in [#defined-in-788]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2487

***

### onDragStartCapture? [#ondragstartcapture-1]

> `optional` **onDragStartCapture**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-654]

`Omit.onDragStartCapture`

#### Defined in [#defined-in-789]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2488

***

### onDrop? [#ondrop-1]

> `optional` **onDrop**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-655]

`Omit.onDrop`

#### Defined in [#defined-in-790]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2489

***

### onDropCapture? [#ondropcapture-1]

> `optional` **onDropCapture**: `DragEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-656]

`Omit.onDropCapture`

#### Defined in [#defined-in-791]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2490

***

### onDurationChange? [#ondurationchange-1]

> `optional` **onDurationChange**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-657]

`Omit.onDurationChange`

#### Defined in [#defined-in-792]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2427

***

### onDurationChangeCapture? [#ondurationchangecapture-1]

> `optional` **onDurationChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-658]

`Omit.onDurationChangeCapture`

#### Defined in [#defined-in-793]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2428

***

### onEmptied? [#onemptied-1]

> `optional` **onEmptied**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-659]

`Omit.onEmptied`

#### Defined in [#defined-in-794]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2429

***

### onEmptiedCapture? [#onemptiedcapture-1]

> `optional` **onEmptiedCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-660]

`Omit.onEmptiedCapture`

#### Defined in [#defined-in-795]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2430

***

### onEncrypted? [#onencrypted-1]

> `optional` **onEncrypted**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-661]

`Omit.onEncrypted`

#### Defined in [#defined-in-796]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2431

***

### onEncryptedCapture? [#onencryptedcapture-1]

> `optional` **onEncryptedCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-662]

`Omit.onEncryptedCapture`

#### Defined in [#defined-in-797]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2432

***

### onEnded? [#onended-1]

> `optional` **onEnded**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-663]

`Omit.onEnded`

#### Defined in [#defined-in-798]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2433

***

### onEndedCapture? [#onendedcapture-1]

> `optional` **onEndedCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-664]

`Omit.onEndedCapture`

#### Defined in [#defined-in-799]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2434

***

### onError? [#onerror-3]

> `optional` **onError**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-665]

`Omit.onError`

#### Defined in [#defined-in-800]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2407

***

### onErrorCapture? [#onerrorcapture-1]

> `optional` **onErrorCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-666]

`Omit.onErrorCapture`

#### Defined in [#defined-in-801]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2408

***

### onFocus? [#onfocus-1]

> `optional` **onFocus**: `FocusEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-667]

`Omit.onFocus`

#### Defined in [#defined-in-802]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2385

***

### onFocusCapture? [#onfocuscapture-1]

> `optional` **onFocusCapture**: `FocusEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-668]

`Omit.onFocusCapture`

#### Defined in [#defined-in-803]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2386

***

### onGotPointerCapture? [#ongotpointercapture-1]

> `optional` **onGotPointerCapture**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-669]

`Omit.onGotPointerCapture`

#### Defined in [#defined-in-804]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2533

***

### onGotPointerCaptureCapture? [#ongotpointercapturecapture-1]

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-670]

`Omit.onGotPointerCaptureCapture`

#### Defined in [#defined-in-805]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2534

***

### onInput? [#oninput-1]

> `optional` **onInput**: `InputEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-671]

`Omit.onInput`

#### Defined in [#defined-in-806]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2395

***

### onInputCapture? [#oninputcapture-1]

> `optional` **onInputCapture**: `InputEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-672]

`Omit.onInputCapture`

#### Defined in [#defined-in-807]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2396

***

### onInvalid? [#oninvalid-1]

> `optional` **onInvalid**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-673]

`Omit.onInvalid`

#### Defined in [#defined-in-808]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2401

***

### onInvalidCapture? [#oninvalidcapture-1]

> `optional` **onInvalidCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-674]

`Omit.onInvalidCapture`

#### Defined in [#defined-in-809]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2402

***

### onKeyDown? [#onkeydown-1]

> `optional` **onKeyDown**: `KeyboardEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-675]

`Omit.onKeyDown`

#### Defined in [#defined-in-810]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2411

***

### onKeyDownCapture? [#onkeydowncapture-1]

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-676]

`Omit.onKeyDownCapture`

#### Defined in [#defined-in-811]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2412

***

### ~~onKeyPress?~~ [#onkeypress-1]

> `optional` **onKeyPress**: `KeyboardEventHandler`\<`HTMLButtonElement`>

#### Deprecated [#deprecated-6]

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from [#inherited-from-677]

`Omit.onKeyPress`

#### Defined in [#defined-in-812]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2414

***

### ~~onKeyPressCapture?~~ [#onkeypresscapture-1]

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`>

#### Deprecated [#deprecated-7]

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from [#inherited-from-678]

`Omit.onKeyPressCapture`

#### Defined in [#defined-in-813]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2416

***

### onKeyUp? [#onkeyup-1]

> `optional` **onKeyUp**: `KeyboardEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-679]

`Omit.onKeyUp`

#### Defined in [#defined-in-814]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2417

***

### onKeyUpCapture? [#onkeyupcapture-1]

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-680]

`Omit.onKeyUpCapture`

#### Defined in [#defined-in-815]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2418

***

### onLoad? [#onload-1]

> `optional` **onLoad**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-681]

`Omit.onLoad`

#### Defined in [#defined-in-816]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2405

***

### onLoadCapture? [#onloadcapture-1]

> `optional` **onLoadCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-682]

`Omit.onLoadCapture`

#### Defined in [#defined-in-817]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2406

***

### onLoadedData? [#onloadeddata-1]

> `optional` **onLoadedData**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-683]

`Omit.onLoadedData`

#### Defined in [#defined-in-818]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2435

***

### onLoadedDataCapture? [#onloadeddatacapture-1]

> `optional` **onLoadedDataCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-684]

`Omit.onLoadedDataCapture`

#### Defined in [#defined-in-819]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2436

***

### onLoadedMetadata? [#onloadedmetadata-1]

> `optional` **onLoadedMetadata**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-685]

`Omit.onLoadedMetadata`

#### Defined in [#defined-in-820]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2437

***

### onLoadedMetadataCapture? [#onloadedmetadatacapture-1]

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-686]

`Omit.onLoadedMetadataCapture`

#### Defined in [#defined-in-821]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2438

***

### onLoadStart? [#onloadstart-1]

> `optional` **onLoadStart**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-687]

`Omit.onLoadStart`

#### Defined in [#defined-in-822]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2439

***

### onLoadStartCapture? [#onloadstartcapture-1]

> `optional` **onLoadStartCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-688]

`Omit.onLoadStartCapture`

#### Defined in [#defined-in-823]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2440

***

### onLostPointerCapture? [#onlostpointercapture-1]

> `optional` **onLostPointerCapture**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-689]

`Omit.onLostPointerCapture`

#### Defined in [#defined-in-824]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2535

***

### onLostPointerCaptureCapture? [#onlostpointercapturecapture-1]

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-690]

`Omit.onLostPointerCaptureCapture`

#### Defined in [#defined-in-825]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2536

***

### onMouseDown? [#onmousedown-1]

> `optional` **onMouseDown**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-691]

`Omit.onMouseDown`

#### Defined in [#defined-in-826]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2491

***

### onMouseDownCapture? [#onmousedowncapture-1]

> `optional` **onMouseDownCapture**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-692]

`Omit.onMouseDownCapture`

#### Defined in [#defined-in-827]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2492

***

### onMouseEnter? [#onmouseenter-1]

> `optional` **onMouseEnter**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-693]

`Omit.onMouseEnter`

#### Defined in [#defined-in-828]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2493

***

### onMouseLeave? [#onmouseleave-1]

> `optional` **onMouseLeave**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-694]

`Omit.onMouseLeave`

#### Defined in [#defined-in-829]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2494

***

### onMouseMove? [#onmousemove-1]

> `optional` **onMouseMove**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-695]

`Omit.onMouseMove`

#### Defined in [#defined-in-830]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2495

***

### onMouseMoveCapture? [#onmousemovecapture-1]

> `optional` **onMouseMoveCapture**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-696]

`Omit.onMouseMoveCapture`

#### Defined in [#defined-in-831]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2496

***

### onMouseOut? [#onmouseout-1]

> `optional` **onMouseOut**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-697]

`Omit.onMouseOut`

#### Defined in [#defined-in-832]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2497

***

### onMouseOutCapture? [#onmouseoutcapture-1]

> `optional` **onMouseOutCapture**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-698]

`Omit.onMouseOutCapture`

#### Defined in [#defined-in-833]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2498

***

### onMouseOver? [#onmouseover-1]

> `optional` **onMouseOver**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-699]

`Omit.onMouseOver`

#### Defined in [#defined-in-834]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2499

***

### onMouseOverCapture? [#onmouseovercapture-1]

> `optional` **onMouseOverCapture**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-700]

`Omit.onMouseOverCapture`

#### Defined in [#defined-in-835]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2500

***

### onMouseUp? [#onmouseup-1]

> `optional` **onMouseUp**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-701]

`Omit.onMouseUp`

#### Defined in [#defined-in-836]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2501

***

### onMouseUpCapture? [#onmouseupcapture-1]

> `optional` **onMouseUpCapture**: `MouseEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-702]

`Omit.onMouseUpCapture`

#### Defined in [#defined-in-837]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2502

***

### onPaste? [#onpaste-1]

> `optional` **onPaste**: `ClipboardEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-703]

`Omit.onPaste`

#### Defined in [#defined-in-838]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2373

***

### onPasteCapture? [#onpastecapture-1]

> `optional` **onPasteCapture**: `ClipboardEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-704]

`Omit.onPasteCapture`

#### Defined in [#defined-in-839]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2374

***

### onPause? [#onpause-1]

> `optional` **onPause**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-705]

`Omit.onPause`

#### Defined in [#defined-in-840]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2441

***

### onPauseCapture? [#onpausecapture-1]

> `optional` **onPauseCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-706]

`Omit.onPauseCapture`

#### Defined in [#defined-in-841]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2442

***

### onPlay? [#onplay-1]

> `optional` **onPlay**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-707]

`Omit.onPlay`

#### Defined in [#defined-in-842]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2443

***

### onPlayCapture? [#onplaycapture-1]

> `optional` **onPlayCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-708]

`Omit.onPlayCapture`

#### Defined in [#defined-in-843]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2444

***

### onPlaying? [#onplaying-1]

> `optional` **onPlaying**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-709]

`Omit.onPlaying`

#### Defined in [#defined-in-844]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2445

***

### onPlayingCapture? [#onplayingcapture-1]

> `optional` **onPlayingCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-710]

`Omit.onPlayingCapture`

#### Defined in [#defined-in-845]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2446

***

### onPointerCancel? [#onpointercancel-1]

> `optional` **onPointerCancel**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-711]

`Omit.onPointerCancel`

#### Defined in [#defined-in-846]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2525

***

### onPointerCancelCapture? [#onpointercancelcapture-1]

> `optional` **onPointerCancelCapture**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-712]

`Omit.onPointerCancelCapture`

#### Defined in [#defined-in-847]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2526

***

### onPointerDown? [#onpointerdown-1]

> `optional` **onPointerDown**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-713]

`Omit.onPointerDown`

#### Defined in [#defined-in-848]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2519

***

### onPointerDownCapture? [#onpointerdowncapture-1]

> `optional` **onPointerDownCapture**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-714]

`Omit.onPointerDownCapture`

#### Defined in [#defined-in-849]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2520

***

### onPointerEnter? [#onpointerenter-1]

> `optional` **onPointerEnter**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-715]

`Omit.onPointerEnter`

#### Defined in [#defined-in-850]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2527

***

### onPointerLeave? [#onpointerleave-1]

> `optional` **onPointerLeave**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-716]

`Omit.onPointerLeave`

#### Defined in [#defined-in-851]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2528

***

### onPointerMove? [#onpointermove-1]

> `optional` **onPointerMove**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-717]

`Omit.onPointerMove`

#### Defined in [#defined-in-852]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2521

***

### onPointerMoveCapture? [#onpointermovecapture-1]

> `optional` **onPointerMoveCapture**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-718]

`Omit.onPointerMoveCapture`

#### Defined in [#defined-in-853]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2522

***

### onPointerOut? [#onpointerout-1]

> `optional` **onPointerOut**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-719]

`Omit.onPointerOut`

#### Defined in [#defined-in-854]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2531

***

### onPointerOutCapture? [#onpointeroutcapture-1]

> `optional` **onPointerOutCapture**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-720]

`Omit.onPointerOutCapture`

#### Defined in [#defined-in-855]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2532

***

### onPointerOver? [#onpointerover-1]

> `optional` **onPointerOver**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-721]

`Omit.onPointerOver`

#### Defined in [#defined-in-856]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2529

***

### onPointerOverCapture? [#onpointerovercapture-1]

> `optional` **onPointerOverCapture**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-722]

`Omit.onPointerOverCapture`

#### Defined in [#defined-in-857]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2530

***

### onPointerUp? [#onpointerup-1]

> `optional` **onPointerUp**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-723]

`Omit.onPointerUp`

#### Defined in [#defined-in-858]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2523

***

### onPointerUpCapture? [#onpointerupcapture-1]

> `optional` **onPointerUpCapture**: `PointerEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-724]

`Omit.onPointerUpCapture`

#### Defined in [#defined-in-859]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2524

***

### onProgress? [#onprogress-1]

> `optional` **onProgress**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-725]

`Omit.onProgress`

#### Defined in [#defined-in-860]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2447

***

### onProgressCapture? [#onprogresscapture-1]

> `optional` **onProgressCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-726]

`Omit.onProgressCapture`

#### Defined in [#defined-in-861]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2448

***

### onRateChange? [#onratechange-1]

> `optional` **onRateChange**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-727]

`Omit.onRateChange`

#### Defined in [#defined-in-862]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2449

***

### onRateChangeCapture? [#onratechangecapture-1]

> `optional` **onRateChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-728]

`Omit.onRateChangeCapture`

#### Defined in [#defined-in-863]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2450

***

### onReset? [#onreset-1]

> `optional` **onReset**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-729]

`Omit.onReset`

#### Defined in [#defined-in-864]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2397

***

### onResetCapture? [#onresetcapture-1]

> `optional` **onResetCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-730]

`Omit.onResetCapture`

#### Defined in [#defined-in-865]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2398

***

### onScroll? [#onscroll-1]

> `optional` **onScroll**: `UIEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-731]

`Omit.onScroll`

#### Defined in [#defined-in-866]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2539

***

### onScrollCapture? [#onscrollcapture-1]

> `optional` **onScrollCapture**: `UIEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-732]

`Omit.onScrollCapture`

#### Defined in [#defined-in-867]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2540

***

### onScrollEnd? [#onscrollend-1]

> `optional` **onScrollEnd**: `UIEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-733]

`Omit.onScrollEnd`

#### Defined in [#defined-in-868]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2541

***

### onScrollEndCapture? [#onscrollendcapture-1]

> `optional` **onScrollEndCapture**: `UIEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-734]

`Omit.onScrollEndCapture`

#### Defined in [#defined-in-869]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2542

***

### onSeeked? [#onseeked-1]

> `optional` **onSeeked**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-735]

`Omit.onSeeked`

#### Defined in [#defined-in-870]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2451

***

### onSeekedCapture? [#onseekedcapture-1]

> `optional` **onSeekedCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-736]

`Omit.onSeekedCapture`

#### Defined in [#defined-in-871]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2452

***

### onSeeking? [#onseeking-1]

> `optional` **onSeeking**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-737]

`Omit.onSeeking`

#### Defined in [#defined-in-872]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2453

***

### onSeekingCapture? [#onseekingcapture-1]

> `optional` **onSeekingCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-738]

`Omit.onSeekingCapture`

#### Defined in [#defined-in-873]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2454

***

### onSelect? [#onselect-1]

> `optional` **onSelect**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-739]

`Omit.onSelect`

#### Defined in [#defined-in-874]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2505

***

### onSelectCapture? [#onselectcapture-1]

> `optional` **onSelectCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-740]

`Omit.onSelectCapture`

#### Defined in [#defined-in-875]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2506

***

### onStalled? [#onstalled-1]

> `optional` **onStalled**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-741]

`Omit.onStalled`

#### Defined in [#defined-in-876]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2455

***

### onStalledCapture? [#onstalledcapture-1]

> `optional` **onStalledCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-742]

`Omit.onStalledCapture`

#### Defined in [#defined-in-877]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2456

***

### onSubmit? [#onsubmit-1]

> `optional` **onSubmit**: `SubmitEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-743]

`Omit.onSubmit`

#### Defined in [#defined-in-878]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2399

***

### onSubmitCapture? [#onsubmitcapture-1]

> `optional` **onSubmitCapture**: `SubmitEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-744]

`Omit.onSubmitCapture`

#### Defined in [#defined-in-879]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2400

***

### onSuspend? [#onsuspend-1]

> `optional` **onSuspend**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-745]

`Omit.onSuspend`

#### Defined in [#defined-in-880]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2457

***

### onSuspendCapture? [#onsuspendcapture-1]

> `optional` **onSuspendCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-746]

`Omit.onSuspendCapture`

#### Defined in [#defined-in-881]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2458

***

### onTimeUpdate? [#ontimeupdate-1]

> `optional` **onTimeUpdate**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-747]

`Omit.onTimeUpdate`

#### Defined in [#defined-in-882]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2459

***

### onTimeUpdateCapture? [#ontimeupdatecapture-1]

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-748]

`Omit.onTimeUpdateCapture`

#### Defined in [#defined-in-883]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2460

***

### onToggle? [#ontoggle-1]

> `optional` **onToggle**: `ToggleEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-749]

`Omit.onToggle`

#### Defined in [#defined-in-884]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2557

***

### onTouchCancel? [#ontouchcancel-1]

> `optional` **onTouchCancel**: `TouchEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-750]

`Omit.onTouchCancel`

#### Defined in [#defined-in-885]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2509

***

### onTouchCancelCapture? [#ontouchcancelcapture-1]

> `optional` **onTouchCancelCapture**: `TouchEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-751]

`Omit.onTouchCancelCapture`

#### Defined in [#defined-in-886]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2510

***

### onTouchEnd? [#ontouchend-1]

> `optional` **onTouchEnd**: `TouchEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-752]

`Omit.onTouchEnd`

#### Defined in [#defined-in-887]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2511

***

### onTouchEndCapture? [#ontouchendcapture-1]

> `optional` **onTouchEndCapture**: `TouchEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-753]

`Omit.onTouchEndCapture`

#### Defined in [#defined-in-888]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2512

***

### onTouchMove? [#ontouchmove-1]

> `optional` **onTouchMove**: `TouchEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-754]

`Omit.onTouchMove`

#### Defined in [#defined-in-889]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2513

***

### onTouchMoveCapture? [#ontouchmovecapture-1]

> `optional` **onTouchMoveCapture**: `TouchEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-755]

`Omit.onTouchMoveCapture`

#### Defined in [#defined-in-890]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2514

***

### onTouchStart? [#ontouchstart-1]

> `optional` **onTouchStart**: `TouchEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-756]

`Omit.onTouchStart`

#### Defined in [#defined-in-891]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2515

***

### onTouchStartCapture? [#ontouchstartcapture-1]

> `optional` **onTouchStartCapture**: `TouchEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-757]

`Omit.onTouchStartCapture`

#### Defined in [#defined-in-892]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2516

***

### onTransitionCancel? [#ontransitioncancel-1]

> `optional` **onTransitionCancel**: `TransitionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-758]

`Omit.onTransitionCancel`

#### Defined in [#defined-in-893]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2561

***

### onTransitionCancelCapture? [#ontransitioncancelcapture-1]

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-759]

`Omit.onTransitionCancelCapture`

#### Defined in [#defined-in-894]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2562

***

### onTransitionEnd? [#ontransitionend-1]

> `optional` **onTransitionEnd**: `TransitionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-760]

`Omit.onTransitionEnd`

#### Defined in [#defined-in-895]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2563

***

### onTransitionEndCapture? [#ontransitionendcapture-1]

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-761]

`Omit.onTransitionEndCapture`

#### Defined in [#defined-in-896]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2564

***

### onTransitionRun? [#ontransitionrun-1]

> `optional` **onTransitionRun**: `TransitionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-762]

`Omit.onTransitionRun`

#### Defined in [#defined-in-897]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2565

***

### onTransitionRunCapture? [#ontransitionruncapture-1]

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-763]

`Omit.onTransitionRunCapture`

#### Defined in [#defined-in-898]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2566

***

### onTransitionStart? [#ontransitionstart-1]

> `optional` **onTransitionStart**: `TransitionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-764]

`Omit.onTransitionStart`

#### Defined in [#defined-in-899]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2567

***

### onTransitionStartCapture? [#ontransitionstartcapture-1]

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-765]

`Omit.onTransitionStartCapture`

#### Defined in [#defined-in-900]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2568

***

### onVolumeChange? [#onvolumechange-1]

> `optional` **onVolumeChange**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-766]

`Omit.onVolumeChange`

#### Defined in [#defined-in-901]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2461

***

### onVolumeChangeCapture? [#onvolumechangecapture-1]

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-767]

`Omit.onVolumeChangeCapture`

#### Defined in [#defined-in-902]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2462

***

### onWaiting? [#onwaiting-1]

> `optional` **onWaiting**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-768]

`Omit.onWaiting`

#### Defined in [#defined-in-903]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2463

***

### onWaitingCapture? [#onwaitingcapture-1]

> `optional` **onWaitingCapture**: `ReactEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-769]

`Omit.onWaitingCapture`

#### Defined in [#defined-in-904]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2464

***

### onWheel? [#onwheel-1]

> `optional` **onWheel**: `WheelEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-770]

`Omit.onWheel`

#### Defined in [#defined-in-905]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2545

***

### onWheelCapture? [#onwheelcapture-1]

> `optional` **onWheelCapture**: `WheelEventHandler`\<`HTMLButtonElement`>

#### Inherited from [#inherited-from-771]

`Omit.onWheelCapture`

#### Defined in [#defined-in-906]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2546

***

### part? [#part-1]

> `optional` **part**: `string`

#### See [#see-66]

[https://developer.mozilla.org/en-US/docs/Web/HTML/Global\_attributes/part](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part)

#### Inherited from [#inherited-from-772]

`Omit.part`

#### Defined in [#defined-in-907]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2966

***

### popover? [#popover]

> `optional` **popover**: `""` | `"auto"` | `"manual"` | `"hint"`

#### Inherited from [#inherited-from-773]

`Omit.popover`

#### Defined in [#defined-in-908]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2940

***

### popoverTarget? [#popovertarget]

> `optional` **popoverTarget**: `string`

#### Inherited from [#inherited-from-774]

`Omit.popoverTarget`

#### Defined in [#defined-in-909]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2942

***

### popoverTargetAction? [#popovertargetaction]

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from [#inherited-from-775]

`Omit.popoverTargetAction`

#### Defined in [#defined-in-910]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2941

***

### prefix? [#prefix]

> `optional` **prefix**: `string`

#### Inherited from [#inherited-from-776]

`Omit.prefix`

#### Defined in [#defined-in-911]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2918

***

### prompt? [#prompt-1]

> `optional` **prompt**: `"none"` | `"login"` | `"consent"` | `"select_account"`

#### Inherited from [#inherited-from-777]

[`AuthSignInOptions`](AuthSignInOptions.md).[`prompt`](AuthSignInOptions.md#prompt)

#### Defined in [#defined-in-912]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:36](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L36)

***

### property? [#property]

> `optional` **property**: `string`

#### Inherited from [#inherited-from-778]

`Omit.property`

#### Defined in [#defined-in-913]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2919

***

### radioGroup? [#radiogroup]

> `optional` **radioGroup**: `string`

#### Inherited from [#inherited-from-779]

`Omit.radioGroup`

#### Defined in [#defined-in-914]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2908

***

### ref? [#ref-1]

> `optional` **ref**: `Ref`\<`HTMLButtonElement`>

Allows getting a ref to the component instance.
Once the component unmounts, React will set `ref.current` to `null`
(or call the ref with `null` if you passed a callback ref).

#### See [#see-67]

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from [#inherited-from-780]

`Omit.ref`

#### Defined in [#defined-in-915]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:301

***

### rel? [#rel]

> `optional` **rel**: `string`

#### Inherited from [#inherited-from-781]

`Omit.rel`

#### Defined in [#defined-in-916]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2920

***

### resource? [#resource]

> `optional` **resource**: `string`

#### Inherited from [#inherited-from-782]

`Omit.resource`

#### Defined in [#defined-in-917]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2921

***

### results? [#results]

> `optional` **results**: `number`

#### Inherited from [#inherited-from-783]

`Omit.results`

#### Defined in [#defined-in-918]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2935

***

### returnTo? [#returnto-2]

> `optional` **returnTo**: `string`

Where to land after the sign-in completes. Same-origin path.

#### Inherited from [#inherited-from-784]

[`AuthSignInOptions`](AuthSignInOptions.md).[`returnTo`](AuthSignInOptions.md#returnto)

#### Defined in [#defined-in-919]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:34](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L34)

***

### rev? [#rev]

> `optional` **rev**: `string`

#### Inherited from [#inherited-from-785]

`Omit.rev`

#### Defined in [#defined-in-920]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2922

***

### role? [#role-2]

> `optional` **role**: `AriaRole`

#### Inherited from [#inherited-from-786]

`Omit.role`

#### Defined in [#defined-in-921]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2911

***

### scope? [#scope-5]

> `optional` **scope**: `string` | readonly `string`\[]

#### Inherited from [#inherited-from-787]

[`AuthSignInOptions`](AuthSignInOptions.md).[`scope`](AuthSignInOptions.md#scope)

#### Defined in [#defined-in-922]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:35](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L35)

***

### security? [#security]

> `optional` **security**: `string`

#### Inherited from [#inherited-from-788]

`Omit.security`

#### Defined in [#defined-in-923]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2936

***

### size? [#size-1]

> `optional` **size**: `null` | `"default"` | `"sm"` | `"lg"` | `"icon"` | `"icon-sm"` | `"icon-lg"`

#### Inherited from [#inherited-from-789]

`Omit.size`

#### Defined in [#defined-in-924]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/ui/button.tsx:24](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/ui/button.tsx#L24)

***

### slot? [#slot-1]

> `optional` **slot**: `string`

#### Inherited from [#inherited-from-790]

`Omit.slot`

#### Defined in [#defined-in-925]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2900

***

### spellCheck? [#spellcheck]

> `optional` **spellCheck**: `Booleanish`

#### Inherited from [#inherited-from-791]

`Omit.spellCheck`

#### Defined in [#defined-in-926]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2901

***

### style? [#style-2]

> `optional` **style**: `CSSProperties`

#### Inherited from [#inherited-from-792]

`Omit.style`

#### Defined in [#defined-in-927]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2902

***

### suppressContentEditableWarning? [#suppresscontenteditablewarning]

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from [#inherited-from-793]

`Omit.suppressContentEditableWarning`

#### Defined in [#defined-in-928]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2883

***

### suppressHydrationWarning? [#suppresshydrationwarning-1]

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from [#inherited-from-794]

`Omit.suppressHydrationWarning`

#### Defined in [#defined-in-929]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2884

***

### tabIndex? [#tabindex-1]

> `optional` **tabIndex**: `number`

#### Inherited from [#inherited-from-795]

`Omit.tabIndex`

#### Defined in [#defined-in-930]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2903

***

### title? [#title]

> `optional` **title**: `string`

#### Inherited from [#inherited-from-796]

`Omit.title`

#### Defined in [#defined-in-931]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2904

***

### translate? [#translate]

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from [#inherited-from-797]

`Omit.translate`

#### Defined in [#defined-in-932]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2905

***

### tw? [#tw]

> `optional` **tw**: `string`

Specify styles using Tailwind CSS classes. This feature is currently experimental.
If `style` prop is also specified, styles generated with `tw` prop will be overridden.

Example:

* `tw='w-full h-full bg-blue-200'`
* `tw='text-9xl'`
* `tw='text-[80px]'`

#### Inherited from [#inherited-from-798]

`Omit.tw`

#### Defined in [#defined-in-933]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/next/dist/compiled/@vercel/og/types.d.ts:70

***

### type? [#type-1]

> `optional` **type**: `"button"` | `"submit"` | `"reset"`

#### Inherited from [#inherited-from-799]

`Omit.type`

#### Defined in [#defined-in-934]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3161

***

### typeof? [#typeof]

> `optional` **typeof**: `string`

#### Inherited from [#inherited-from-800]

`Omit.typeof`

#### Defined in [#defined-in-935]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2923

***

### unselectable? [#unselectable]

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from [#inherited-from-801]

`Omit.unselectable`

#### Defined in [#defined-in-936]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2937

***

### value? [#value]

> `optional` **value**: `string` | `number` | readonly `string`\[]

#### Inherited from [#inherited-from-802]

`Omit.value`

#### Defined in [#defined-in-937]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:3162

***

### variant? [#variant]

> `optional` **variant**: `"outline"` | `"brand"`

`brand` (default): the app's orange call to action. `outline`: the secondary style.

#### Defined in [#defined-in-938]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignInButton.tsx:27](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignInButton.tsx#L27)

***

### vocab? [#vocab]

> `optional` **vocab**: `string`

#### Inherited from [#inherited-from-803]

`Omit.vocab`

#### Defined in [#defined-in-939]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/react/index.d.ts:2924

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / SignInProps

# Interface: SignInProps [#interface-signinprops]

## Extends [#extends-5]

* [`AuthSignInOptions`](AuthSignInOptions.md)

## Properties [#properties-16]

### appName? [#appname]

> `optional` **appName**: `string`

Your app's name, used in the title.

#### Defined in [#defined-in-940]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:38](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L38)

***

### children? [#children-3]

> `optional` **children**: `ReactNode`

Extra content under the button.

#### Defined in [#defined-in-941]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:53](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L53)

***

### className? [#classname-2]

> `optional` **className**: `string`

#### Defined in [#defined-in-942]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:54](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L54)

***

### description? [#description]

> `optional` **description**: `ReactNode`

The muted line under the headline. Default names the methods.

#### Defined in [#defined-in-943]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:45](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L45)

***

### errorMessage? [#errormessage]

> `optional` **errorMessage**: `ReactNode`

#### Defined in [#defined-in-944]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:55](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L55)

***

### headingLevel? [#headinglevel]

> `optional` **headingLevel**: `3` | `2` | `1`

Heading level of the title. Default 1.

#### Defined in [#defined-in-945]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:51](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L51)

***

### headline? [#headline]

> `optional` **headline**: `ReactNode`

The bold line under the title. Default "Use your Alternate Clouds account".

#### Defined in [#defined-in-946]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:43](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L43)

***

### loginHint? [#loginhint-2]

> `optional` **loginHint**: `string`

#### Inherited from [#inherited-from-804]

[`AuthSignInOptions`](AuthSignInOptions.md).[`loginHint`](AuthSignInOptions.md#loginhint)

#### Defined in [#defined-in-947]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:37](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L37)

***

### logo? [#logo]

> `optional` **logo**: `ReactNode`

Your logo, rendered above the title.

#### Defined in [#defined-in-948]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:40](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L40)

***

### methods? [#methods-4]

> `optional` **methods**: [`SignInMethod`](../type-aliases/SignInMethod.md)\[]

Methods listed in the description. Default: all three.

#### Defined in [#defined-in-949]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:47](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L47)

***

### privacyUrl? [#privacyurl]

> `optional` **privacyUrl**: `string`

#### Defined in [#defined-in-950]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:49](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L49)

***

### prompt? [#prompt-2]

> `optional` **prompt**: `"none"` | `"login"` | `"consent"` | `"select_account"`

#### Inherited from [#inherited-from-805]

[`AuthSignInOptions`](AuthSignInOptions.md).[`prompt`](AuthSignInOptions.md#prompt)

#### Defined in [#defined-in-951]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:36](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L36)

***

### returnTo? [#returnto-3]

> `optional` **returnTo**: `string`

Where to land after the sign-in completes. Same-origin path.

#### Inherited from [#inherited-from-806]

[`AuthSignInOptions`](AuthSignInOptions.md).[`returnTo`](AuthSignInOptions.md#returnto)

#### Defined in [#defined-in-952]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:34](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L34)

***

### scope? [#scope-6]

> `optional` **scope**: `string` | readonly `string`\[]

#### Inherited from [#inherited-from-807]

[`AuthSignInOptions`](AuthSignInOptions.md).[`scope`](AuthSignInOptions.md#scope)

#### Defined in [#defined-in-953]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:35](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L35)

***

### termsUrl? [#termsurl]

> `optional` **termsUrl**: `string`

#### Defined in [#defined-in-954]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:48](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L48)

***

### title? [#title-1]

> `optional` **title**: `ReactNode`

#### Defined in [#defined-in-955]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:41](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L41)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / SignedProps

# Interface: SignedProps [#interface-signedprops]

## Properties [#properties-17]

### children? [#children-4]

> `optional` **children**: `ReactNode`

#### Defined in [#defined-in-956]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/Signed.tsx:7](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/Signed.tsx#L7)

***

### fallback? [#fallback]

> `optional` **fallback**: `ReactNode`

Rendered while the session is still loading. Default nothing.

#### Defined in [#defined-in-957]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/Signed.tsx:9](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/Signed.tsx#L9)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / UserButtonItemProps

# Interface: UserButtonItemProps [#interface-userbuttonitemprops]

## Properties [#properties-18]

### children [#children-5]

> **children**: `ReactNode`

#### Defined in [#defined-in-958]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:37](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L37)

***

### className? [#classname-3]

> `optional` **className**: `string`

#### Defined in [#defined-in-959]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:38](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L38)

***

### href? [#href-1]

> `optional` **href**: `string`

#### Defined in [#defined-in-960]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:35](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L35)

***

### onSelect()? [#onselect-2]

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

#### Returns [#returns-67]

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

#### Defined in [#defined-in-961]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:36](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L36)

***

### variant? [#variant-1]

> `optional` **variant**: `"default"` | `"destructive"`

#### Defined in [#defined-in-962]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:39](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L39)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / UserButtonProps

# Interface: UserButtonProps [#interface-userbuttonprops]

## Extends [#extends-6]

* [`AuthSignOutOptions`](AuthSignOutOptions.md)

## Properties [#properties-19]

### accountLabel? [#accountlabel]

> `optional` **accountLabel**: `ReactNode`

#### Defined in [#defined-in-963]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:31](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L31)

***

### accountUrl? [#accounturl]

> `optional` **accountUrl**: `null` | `string`

Where "Account settings" goes. Default: the Alternate Clouds account settings. `null` hides it.

#### Defined in [#defined-in-964]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:26](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L26)

***

### children? [#children-6]

> `optional` **children**: `ReactNode`

Extra menu items, rendered between "Account settings" and "Log out". Use `<UserButtonItem>`.

#### Defined in [#defined-in-965]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:28](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L28)

***

### className? [#classname-4]

> `optional` **className**: `string`

#### Defined in [#defined-in-966]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:29](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L29)

***

### returnTo? [#returnto-4]

> `optional` **returnTo**: `string`

Where to land after signing out (client mode: the registered post-logout redirect URI is used when set).

#### Inherited from [#inherited-from-808]

[`AuthSignOutOptions`](AuthSignOutOptions.md).[`returnTo`](AuthSignOutOptions.md#returnto)

#### Defined in [#defined-in-967]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:42](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L42)

***

### showName? [#showname]

> `optional` **showName**: `boolean`

Show the name next to the avatar (the web app shows the avatar alone).

#### Defined in [#defined-in-968]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:24](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L24)

***

### signOutLabel? [#signoutlabel]

> `optional` **signOutLabel**: `ReactNode`

#### Defined in [#defined-in-969]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:30](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L30)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / AuthStatus

# Type Alias: AuthStatus [#type-alias-authstatus]

> **AuthStatus**: `"loading"` | `"signed-in"` | `"signed-out"`

## Defined in [#defined-in-970]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:30](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L30)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / AuthTheme

# Type Alias: AuthTheme [#type-alias-auththeme]

> **AuthTheme**: `"light"` | `"dark"` | `"system"` | `"inherit"`

## Defined in [#defined-in-971]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:75](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/context.tsx#L75)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / SignInMethod

# Type Alias: SignInMethod [#type-alias-signinmethod]

> **SignInMethod**: `"email"` | `"sms"` | `"wallet"`

## Defined in [#defined-in-972]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:19](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L19)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / AUTH\_CARD\_CLASS

# Variable: AUTH\_CARD\_CLASS [#variable-auth_card_class]

> `const` **AUTH\_CARD\_CLASS**: `"w-full px-6 py-10 dark:border-[#444444]"` = `'w-full px-6 py-10 dark:border-[#444444]'`

The web app's auth card classes (AuthPage `authCardClass`, without the marketing-panel sizing).

## Defined in [#defined-in-973]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:34](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignIn.tsx#L34)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / BRAND\_BUTTON\_CLASS

# Variable: BRAND\_BUTTON\_CLASS [#variable-brand_button_class]

> `const` **BRAND\_BUTTON\_CLASS**: `"bg-orange-700 text-white hover:bg-orange-700/90"` = `'bg-orange-700 text-white hover:bg-orange-700/90'`

The web app's brand button classes (components/auth/AuthPage.tsx `brandButtonClass`).

## Defined in [#defined-in-974]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignInButton.tsx:23](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignInButton.tsx#L23)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / DEFAULT\_ACCOUNT\_URL

# Variable: DEFAULT\_ACCOUNT\_URL [#variable-default_account_url]

> `const` **DEFAULT\_ACCOUNT\_URL**: `"https://clouds.alternatefutures.ai/account/settings"` = `'https://clouds.alternatefutures.ai/account/settings'`

## Defined in [#defined-in-975]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:20](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/UserButton.tsx#L20)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth-react/src](../README.md) / SIGN\_IN\_LABEL

# Variable: SIGN\_IN\_LABEL [#variable-sign_in_label]

> `const` **SIGN\_IN\_LABEL**: `"Continue with Alternate Clouds"` = `'Continue with Alternate Clouds'`

## Defined in [#defined-in-976]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignInButton.tsx:20](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth-react/src/components/SignInButton.tsx#L20)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../README.md) / ac-auth/src

# ac-auth/src [#ac-authsrc]

@alternatefutures/ac-auth

Sign in with Alternate Clouds, framework-free. Start with
[createAuthClient](functions/createAuthClient.md) for a browser app; use the lower-level functions
to build a server-side session (see @alternatefutures/ac-auth-next).

## Index [#index-5]

### Classes [#classes-1]

* [AuthClient](classes/AuthClient.md)
* [AuthError](classes/AuthError.md)
* [OAuthError](classes/OAuthError.md)
* [RefreshCoordinator](classes/RefreshCoordinator.md)

### Interfaces [#interfaces-5]

* [AuthClientOptions](interfaces/AuthClientOptions.md)
* [AuthorizationRequestParams](interfaces/AuthorizationRequestParams.md)
* [AuthorizationResponse](interfaces/AuthorizationResponse.md)
* [AuthStorage](interfaces/AuthStorage.md)
* [AuthUser](interfaces/AuthUser.md)
* [CallbackResult](interfaces/CallbackResult.md)
* [CodeExchangeParams](interfaces/CodeExchangeParams.md)
* [DeviceAuthorizationParams](interfaces/DeviceAuthorizationParams.md)
* [DeviceAuthorizationResponse](interfaces/DeviceAuthorizationResponse.md)
* [DevicePollParams](interfaces/DevicePollParams.md)
* [DiscoverOptions](interfaces/DiscoverOptions.md)
* [DiscoveryCacheOptions](interfaces/DiscoveryCacheOptions.md)
* [EndSessionParams](interfaces/EndSessionParams.md)
* [IdTokenClaims](interfaces/IdTokenClaims.md)
* [IntrospectionParams](interfaces/IntrospectionParams.md)
* [IntrospectionResponse](interfaces/IntrospectionResponse.md)
* [IssuerMetadata](interfaces/IssuerMetadata.md)
* [JwksResolver](interfaces/JwksResolver.md)
* [JwksResolverOptions](interfaces/JwksResolverOptions.md)
* [JwksSnapshot](interfaces/JwksSnapshot.md)
* [OAuthErrorBody](interfaces/OAuthErrorBody.md)
* [OrganizationClaim](interfaces/OrganizationClaim.md)
* [PkcePair](interfaces/PkcePair.md)
* [RefreshCoordinatorOptions](interfaces/RefreshCoordinatorOptions.md)
* [RefreshParams](interfaces/RefreshParams.md)
* [RevocationParams](interfaces/RevocationParams.md)
* [Session](interfaces/Session.md)
* [SessionGracePolicy](interfaces/SessionGracePolicy.md)
* [SignInOptions](interfaces/SignInOptions.md)
* [SignOutOptions](interfaces/SignOutOptions.md)
* [TokenEndpointClient](interfaces/TokenEndpointClient.md)
* [TokenResponse](interfaces/TokenResponse.md)
* [TokenSet](interfaces/TokenSet.md)
* [UserInfoParams](interfaces/UserInfoParams.md)
* [VerifyIdTokenOptions](interfaces/VerifyIdTokenOptions.md)

### Type Aliases [#type-aliases-3]

* [AuthErrorCode](type-aliases/AuthErrorCode.md)
* [ClientAuthentication](type-aliases/ClientAuthentication.md)
* [FetchLike](type-aliases/FetchLike.md)
* [GraceVerdict](type-aliases/GraceVerdict.md)
* [JWK](type-aliases/JWK.md)
* [JwksSource](type-aliases/JwksSource.md)
* [OrganizationRole](type-aliases/OrganizationRole.md)
* [SessionListener](type-aliases/SessionListener.md)
* [SessionStatus](type-aliases/SessionStatus.md)
* [StorageKind](type-aliases/StorageKind.md)

### Variables [#variables-3]

* [DEFAULT\_GRACE\_POLICY](variables/DEFAULT_GRACE_POLICY.md)
* [DEFAULT\_ISSUER](variables/DEFAULT_ISSUER.md)
* [DEFAULT\_SCOPES](variables/DEFAULT_SCOPES.md)
* [DEVICE\_CODE\_GRANT](variables/DEVICE_CODE_GRANT.md)
* [EMBEDDED\_JWKS](variables/EMBEDDED_JWKS.md)
* [ID\_TOKEN\_ALGORITHMS](variables/ID_TOKEN_ALGORITHMS.md)
* [ISSUER\_PATHS](variables/ISSUER_PATHS.md)
* [NO\_GRACE\_POLICY](variables/NO_GRACE_POLICY.md)
* [SUPPORTED\_SCOPES](variables/SUPPORTED_SCOPES.md)

### Functions [#functions-5]

* [buildAuthorizationUrl](functions/buildAuthorizationUrl.md)
* [buildEndSessionUrl](functions/buildEndSessionUrl.md)
* [clientAuthenticationParts](functions/clientAuthenticationParts.md)
* [computeCodeChallenge](functions/computeCodeChallenge.md)
* [createAuthClient](functions/createAuthClient.md)
* [createDiscoveryCache](functions/createDiscoveryCache.md)
* [createJwksResolver](functions/createJwksResolver.md)
* [createPkcePair](functions/createPkcePair.md)
* [decodeIdToken](functions/decodeIdToken.md)
* [discover](functions/discover.md)
* [embeddedKeysFor](functions/embeddedKeysFor.md)
* [evaluateGrace](functions/evaluateGrace.md)
* [exchangeAuthorizationCode](functions/exchangeAuthorizationCode.md)
* [fetchUserInfo](functions/fetchUserInfo.md)
* [generateCodeVerifier](functions/generateCodeVerifier.md)
* [generateNonce](functions/generateNonce.md)
* [generateState](functions/generateState.md)
* [graceDeadline](functions/graceDeadline.md)
* [introspectToken](functions/introspectToken.md)
* [isAuthorizationResponse](functions/isAuthorizationResponse.md)
* [isPublicSigningJwk](functions/isPublicSigningJwk.md)
* [isSignedOutError](functions/isSignedOutError.md)
* [isTransientError](functions/isTransientError.md)
* [knownIssuerMetadata](functions/knownIssuerMetadata.md)
* [memoryStorage](functions/memoryStorage.md)
* [oauthErrorFromBody](functions/oauthErrorFromBody.md)
* [parseAuthorizationResponse](functions/parseAuthorizationResponse.md)
* [pollDeviceToken](functions/pollDeviceToken.md)
* [refreshTokenGrant](functions/refreshTokenGrant.md)
* [resolveGracePolicy](functions/resolveGracePolicy.md)
* [resolveStorage](functions/resolveStorage.md)
* [revokeToken](functions/revokeToken.md)
* [shortWallet](functions/shortWallet.md)
* [startDeviceAuthorization](functions/startDeviceAuthorization.md)
* [tokenSetFromResponse](functions/tokenSetFromResponse.md)
* [userFromClaims](functions/userFromClaims.md)
* [userInitials](functions/userInitials.md)
* [verifyIdToken](functions/verifyIdToken.md)
* [webStorage](functions/webStorage.md)
* [withLock](functions/withLock.md)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / AuthClient

# Class: AuthClient [#class-authclient]

## Constructors [#constructors-1]

### new AuthClient() [#new-authclient]

> **new AuthClient**(`options`): [`AuthClient`](AuthClient.md)

#### Parameters [#parameters-52]

• **options**: [`AuthClientOptions`](../interfaces/AuthClientOptions.md)

#### Returns [#returns-68]

[`AuthClient`](AuthClient.md)

#### Defined in [#defined-in-977]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:137](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L137)

## Properties [#properties-20]

### clientId [#clientid-2]

> `readonly` **clientId**: `string`

#### Defined in [#defined-in-978]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:121](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L121)

***

### issuer [#issuer-2]

> `readonly` **issuer**: `string`

#### Defined in [#defined-in-979]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:120](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L120)

***

### redirectUri [#redirecturi-1]

> `readonly` **redirectUri**: `string`

#### Defined in [#defined-in-980]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:122](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L122)

## Methods [#methods-5]

### clear() [#clear]

> **clear**(): `void`

Forget the stored tokens without telling the issuer.

#### Returns [#returns-69]

`void`

#### Defined in [#defined-in-981]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:432](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L432)

***

### createSignInUrl() [#createsigninurl]

> **createSignInUrl**(`options`): `Promise`\<`object`>

#### Parameters [#parameters-53]

• **options**: [`SignInOptions`](../interfaces/SignInOptions.md) = `{}`

#### Returns [#returns-70]

`Promise`\<`object`>

##### state [#state]

> **state**: `string`

##### url [#url]

> **url**: `string`

#### Defined in [#defined-in-982]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:194](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L194)

***

### getAccessToken() [#getaccesstoken]

> **getAccessToken**(): `Promise`\<`null` | `string`>

A valid access token, refreshing when needed. Null when signed out (a grace session still answers its last token).

#### Returns [#returns-71]

`Promise`\<`null` | `string`>

#### Defined in [#defined-in-983]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:361](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L361)

***

### getSession() [#getsession-1]

> **getSession**(`options`): `Promise`\<`null` | [`Session`](../interfaces/Session.md)>

The current session, refreshed when the access token is (about to be)
expired. `refresh: 'never'` answers from storage only; `'force'` always
refreshes. Returns null when signed out.

#### Parameters [#parameters-54]

• **options** = `{}`

• &#x2A;*options.refresh?**: `"auto"` | `"force"` | `"never"`

#### Returns [#returns-72]

`Promise`\<`null` | [`Session`](../interfaces/Session.md)>

#### Defined in [#defined-in-984]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:320](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L320)

***

### getUser() [#getuser]

> **getUser**(): `Promise`\<`null` | [`AuthUser`](../interfaces/AuthUser.md)>

#### Returns [#returns-73]

`Promise`\<`null` | [`AuthUser`](../interfaces/AuthUser.md)>

#### Defined in [#defined-in-985]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:366](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L366)

***

### handleCallback() [#handlecallback-1]

> **handleCallback**(`url`?): `Promise`\<[`CallbackResult`](../interfaces/CallbackResult.md)>

Finish the sign-in on the redirect URI: match the state to the pending
transaction, exchange the code with PKCE, verify the ID token (nonce
included), store the tokens.

#### Parameters [#parameters-55]

• &#x2A;*url?**: `string` | `URL`

#### Returns [#returns-74]

`Promise`\<[`CallbackResult`](../interfaces/CallbackResult.md)>

#### Defined in [#defined-in-986]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:260](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L260)

***

### isCallback() [#iscallback]

> **isCallback**(`url`?): `boolean`

Whether `url` (default: the current page) is a redirect back from the issuer.

#### Parameters [#parameters-56]

• &#x2A;*url?**: `string` | `URL`

#### Returns [#returns-75]

`boolean`

#### Defined in [#defined-in-987]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:245](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L245)

***

### jwks() [#jwks]

> **jwks**(): [`JwksResolver`](../interfaces/JwksResolver.md)

The JWKS resolver (for verifying tokens outside the client).

#### Returns [#returns-76]

[`JwksResolver`](../interfaces/JwksResolver.md)

#### Defined in [#defined-in-988]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:188](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L188)

***

### metadata() [#metadata-2]

> **metadata**(): `Promise`\<[`IssuerMetadata`](../interfaces/IssuerMetadata.md)>

The issuer's metadata (discovered once, cached, stale-on-error, known layout as the last resort).

#### Returns [#returns-77]

`Promise`\<[`IssuerMetadata`](../interfaces/IssuerMetadata.md)>

#### Defined in [#defined-in-989]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:176](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L176)

***

### peekSession() [#peeksession]

> **peekSession**(): `null` | [`Session`](../interfaces/Session.md)

The session as stored, without any network call. Null when nothing is stored or the grace cap passed.

#### Returns [#returns-78]

`null` | [`Session`](../interfaces/Session.md)

#### Defined in [#defined-in-990]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:376](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L376)

***

### refresh() [#refresh-2]

> **refresh**(): `Promise`\<`null` | [`Session`](../interfaces/Session.md)>

Force a refresh now.

#### Returns [#returns-79]

`Promise`\<`null` | [`Session`](../interfaces/Session.md)>

#### Defined in [#defined-in-991]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:371](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L371)

***

### setTokens() [#settokens]

> **setTokens**(`tokens`): [`Session`](../interfaces/Session.md)

Replace the stored tokens (server-side sessions, tests).

#### Parameters [#parameters-57]

• **tokens**: [`TokenSet`](../interfaces/TokenSet.md)

#### Returns [#returns-80]

[`Session`](../interfaces/Session.md)

#### Defined in [#defined-in-992]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:385](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L385)

***

### signIn() [#signin-3]

> **signIn**(`options`): `Promise`\<`void`>

Start the sign-in: build the URL and leave the page.

#### Parameters [#parameters-58]

• **options**: [`SignInOptions`](../interfaces/SignInOptions.md) = `{}`

#### Returns [#returns-81]

`Promise`\<`void`>

#### Defined in [#defined-in-993]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:227](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L227)

***

### signOut() [#signout-2]

> **signOut**(`options`): `Promise`\<`object`>

End the local session; optionally revoke the refresh token and leave for the issuer's end-session page.

#### Parameters [#parameters-59]

• **options**: [`SignOutOptions`](../interfaces/SignOutOptions.md) = `{}`

#### Returns [#returns-82]

`Promise`\<`object`>

##### endSessionUrl [#endsessionurl]

> **endSessionUrl**: `null` | `string`

#### Defined in [#defined-in-994]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:393](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L393)

***

### subscribe() [#subscribe-1]

> **subscribe**(`listener`): () => `void`

#### Parameters [#parameters-60]

• **listener**: [`SessionListener`](../type-aliases/SessionListener.md)

#### Returns [#returns-83]

`Function`

##### Returns [#returns-84]

`void`

#### Defined in [#defined-in-995]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:438](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L438)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / AuthError

# Class: AuthError [#class-autherror]

## Extends [#extends-7]

* `Error`

## Extended by [#extended-by-2]

* [`OAuthError`](OAuthError.md)

## Constructors [#constructors-2]

### new AuthError() [#new-autherror]

> **new AuthError**(`code`, `message`, `options`?): [`AuthError`](AuthError.md)

#### Parameters [#parameters-61]

• **code**: [`AuthErrorCode`](../type-aliases/AuthErrorCode.md)

• **message**: `string`

• &#x2A;*options?**

• &#x2A;*options.cause?**: `unknown`

#### Returns [#returns-85]

[`AuthError`](AuthError.md)

#### Overrides [#overrides-2]

`Error.constructor`

#### Defined in [#defined-in-996]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:51](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L51)

## Properties [#properties-21]

### cause? [#cause]

> `optional` **cause**: `unknown`

#### Inherited from [#inherited-from-809]

`Error.cause`

#### Defined in [#defined-in-997]

.npm/\_npx/41a97ebe2dc4ae32/node\_modules/typescript/lib/lib.es2022.error.d.ts:24

***

### code [#code]

> `readonly` **code**: [`AuthErrorCode`](../type-aliases/AuthErrorCode.md)

#### Defined in [#defined-in-998]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:49](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L49)

***

### message [#message]

> **message**: `string`

#### Inherited from [#inherited-from-810]

`Error.message`

#### Defined in [#defined-in-999]

.npm/\_npx/41a97ebe2dc4ae32/node\_modules/typescript/lib/lib.es5.d.ts:1077

***

### name [#name-4]

> **name**: `string`

#### Inherited from [#inherited-from-811]

`Error.name`

#### Defined in [#defined-in-1000]

.npm/\_npx/41a97ebe2dc4ae32/node\_modules/typescript/lib/lib.es5.d.ts:1076

***

### stack? [#stack]

> `optional` **stack**: `string`

#### Inherited from [#inherited-from-812]

`Error.stack`

#### Defined in [#defined-in-1001]

.npm/\_npx/41a97ebe2dc4ae32/node\_modules/typescript/lib/lib.es5.d.ts:1078

***

### stackTraceLimit [#stacktracelimit]

> `static` **stackTraceLimit**: `number`

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured *after* the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

#### Inherited from [#inherited-from-813]

`Error.stackTraceLimit`

#### Defined in [#defined-in-1002]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/node/globals.d.ts:68

## Methods [#methods-6]

### captureStackTrace() [#capturestacktrace]

> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

#### Parameters [#parameters-62]

• **targetObject**: `object`

• &#x2A;*constructorOpt?**: `Function`

#### Returns [#returns-86]

`void`

#### Inherited from [#inherited-from-814]

`Error.captureStackTrace`

#### Defined in [#defined-in-1003]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/node/globals.d.ts:52

***

### prepareStackTrace() [#preparestacktrace]

> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

#### Parameters [#parameters-63]

• **err**: `Error`

• **stackTraces**: `CallSite`\[]

#### Returns [#returns-87]

`any`

#### See [#see-68]

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

#### Inherited from [#inherited-from-815]

`Error.prepareStackTrace`

#### Defined in [#defined-in-1004]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/node/globals.d.ts:56

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / OAuthError

# Class: OAuthError [#class-oautherror]

## Extends [#extends-8]

* [`AuthError`](AuthError.md)

## Constructors [#constructors-3]

### new OAuthError() [#new-oautherror]

> **new OAuthError**(`body`, `status`, `options`?): [`OAuthError`](OAuthError.md)

#### Parameters [#parameters-64]

• **body**: [`OAuthErrorBody`](../interfaces/OAuthErrorBody.md)

• **status**: `number`

• &#x2A;*options?**

• &#x2A;*options.cause?**: `unknown`

#### Returns [#returns-88]

[`OAuthError`](OAuthError.md)

#### Overrides [#overrides-3]

[`AuthError`](AuthError.md).[`constructor`](AuthError.md#constructors)

#### Defined in [#defined-in-1005]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:73](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L73)

## Properties [#properties-22]

### cause? [#cause-1]

> `optional` **cause**: `unknown`

#### Inherited from [#inherited-from-816]

[`AuthError`](AuthError.md).[`cause`](AuthError.md#cause)

#### Defined in [#defined-in-1006]

.npm/\_npx/41a97ebe2dc4ae32/node\_modules/typescript/lib/lib.es2022.error.d.ts:24

***

### code [#code-1]

> `readonly` **code**: [`AuthErrorCode`](../type-aliases/AuthErrorCode.md)

#### Inherited from [#inherited-from-817]

[`AuthError`](AuthError.md).[`code`](AuthError.md#code)

#### Defined in [#defined-in-1007]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:49](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L49)

***

### error [#error-1]

> `readonly` **error**: `string`

The `error` string from the issuer (`invalid_grant`, `invalid_client`, ...).

#### Defined in [#defined-in-1008]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:67](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L67)

***

### errorDescription [#errordescription]

> `readonly` **errorDescription**: `undefined` | `string`

#### Defined in [#defined-in-1009]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:68](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L68)

***

### errorUri [#erroruri]

> `readonly` **errorUri**: `undefined` | `string`

#### Defined in [#defined-in-1010]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:69](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L69)

***

### message [#message-1]

> **message**: `string`

#### Inherited from [#inherited-from-818]

[`AuthError`](AuthError.md).[`message`](AuthError.md#message)

#### Defined in [#defined-in-1011]

.npm/\_npx/41a97ebe2dc4ae32/node\_modules/typescript/lib/lib.es5.d.ts:1077

***

### name [#name-5]

> **name**: `string`

#### Inherited from [#inherited-from-819]

[`AuthError`](AuthError.md).[`name`](AuthError.md#name)

#### Defined in [#defined-in-1012]

.npm/\_npx/41a97ebe2dc4ae32/node\_modules/typescript/lib/lib.es5.d.ts:1076

***

### stack? [#stack-1]

> `optional` **stack**: `string`

#### Inherited from [#inherited-from-820]

[`AuthError`](AuthError.md).[`stack`](AuthError.md#stack)

#### Defined in [#defined-in-1013]

.npm/\_npx/41a97ebe2dc4ae32/node\_modules/typescript/lib/lib.es5.d.ts:1078

***

### status [#status-5]

> `readonly` **status**: `number`

HTTP status of the answer, or 0 when the error came back on a redirect.

#### Defined in [#defined-in-1014]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:71](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L71)

***

### stackTraceLimit [#stacktracelimit-1]

> `static` **stackTraceLimit**: `number`

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured *after* the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

#### Inherited from [#inherited-from-821]

[`AuthError`](AuthError.md).[`stackTraceLimit`](AuthError.md#stacktracelimit)

#### Defined in [#defined-in-1015]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/node/globals.d.ts:68

## Methods [#methods-7]

### captureStackTrace() [#capturestacktrace-1]

> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

#### Parameters [#parameters-65]

• **targetObject**: `object`

• &#x2A;*constructorOpt?**: `Function`

#### Returns [#returns-89]

`void`

#### Inherited from [#inherited-from-822]

[`AuthError`](AuthError.md).[`captureStackTrace`](AuthError.md#capturestacktrace)

#### Defined in [#defined-in-1016]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/node/globals.d.ts:52

***

### prepareStackTrace() [#preparestacktrace-1]

> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

#### Parameters [#parameters-66]

• **err**: `Error`

• **stackTraces**: `CallSite`\[]

#### Returns [#returns-90]

`any`

#### See [#see-69]

[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)

#### Inherited from [#inherited-from-823]

[`AuthError`](AuthError.md).[`prepareStackTrace`](AuthError.md#preparestacktrace)

#### Defined in [#defined-in-1017]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/@types/node/globals.d.ts:56

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / RefreshCoordinator

# Class: RefreshCoordinator\<T> [#class-refreshcoordinatort]

## Type Parameters [#type-parameters-1]

• **T** = [`TokenSet`](../interfaces/TokenSet.md)

## Constructors [#constructors-4]

### new RefreshCoordinator() [#new-refreshcoordinator]

> **new RefreshCoordinator**\<`T`>(`options`): [`RefreshCoordinator`](RefreshCoordinator.md)\<`T`>

#### Parameters [#parameters-67]

• **options**: [`RefreshCoordinatorOptions`](../interfaces/RefreshCoordinatorOptions.md)\<`T`>

#### Returns [#returns-91]

[`RefreshCoordinator`](RefreshCoordinator.md)\<`T`>

#### Defined in [#defined-in-1018]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/refresh.ts:46](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/refresh.ts#L46)

## Methods [#methods-8]

### isConsumed() [#isconsumed]

> **isConsumed**(`refreshToken`): `boolean`

Whether this token was already used (or refused) and must not be sent again.

#### Parameters [#parameters-68]

• **refreshToken**: `string`

#### Returns [#returns-92]

`boolean`

#### Defined in [#defined-in-1019]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/refresh.ts:57](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/refresh.ts#L57)

***

### refresh() [#refresh-3]

> **refresh**(`refreshToken`): `Promise`\<`T`>

#### Parameters [#parameters-69]

• **refreshToken**: `string`

#### Returns [#returns-93]

`Promise`\<`T`>

#### Defined in [#defined-in-1020]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/refresh.ts:61](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/refresh.ts#L61)

***

### reset() [#reset]

> **reset**(): `void`

Forget everything (sign-out, tests).

#### Returns [#returns-94]

`void`

#### Defined in [#defined-in-1021]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/refresh.ts:104](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/refresh.ts#L104)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / buildAuthorizationUrl

# Function: buildAuthorizationUrl() [#function-buildauthorizationurl]

> **buildAuthorizationUrl**(`params`): `string`

## Parameters [#parameters-70]

• **params**: [`AuthorizationRequestParams`](../interfaces/AuthorizationRequestParams.md)

## Returns [#returns-95]

`string`

## Defined in [#defined-in-1022]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:33](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L33)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / buildEndSessionUrl

# Function: buildEndSessionUrl() [#function-buildendsessionurl]

> **buildEndSessionUrl**(`params`): `string` | `null`

The RP-initiated logout URL, or null when the issuer publishes no end-session endpoint.

## Parameters [#parameters-71]

• **params**: [`EndSessionParams`](../interfaces/EndSessionParams.md)

## Returns [#returns-96]

`string` | `null`

## Defined in [#defined-in-1023]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:122](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L122)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / clientAuthenticationParts

# Function: clientAuthenticationParts() [#function-clientauthenticationparts]

> **clientAuthenticationParts**(`clientId`, `authentication`): `object`

Body fields and headers that authenticate the client for one request.

## Parameters [#parameters-72]

• **clientId**: `string`

• **authentication**: `undefined` | [`ClientAuthentication`](../type-aliases/ClientAuthentication.md)

## Returns [#returns-97]

`object`

### body [#body]

> **body**: `Record`\<`string`, `string`>

### headers [#headers]

> **headers**: `Record`\<`string`, `string`>

## Defined in [#defined-in-1024]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:32](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L32)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / computeCodeChallenge

# Function: computeCodeChallenge() [#function-computecodechallenge]

> **computeCodeChallenge**(`codeVerifier`): `Promise`\<`string`>

`BASE64URL(SHA256(ASCII(verifier)))`.

## Parameters [#parameters-73]

• **codeVerifier**: `string`

## Returns [#returns-98]

`Promise`\<`string`>

## Defined in [#defined-in-1025]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/pkce.ts:14](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/pkce.ts#L14)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / createAuthClient

# Function: createAuthClient() [#function-createauthclient]

> **createAuthClient**(`options`): [`AuthClient`](../classes/AuthClient.md)

## Parameters [#parameters-74]

• **options**: [`AuthClientOptions`](../interfaces/AuthClientOptions.md)

## Returns [#returns-99]

[`AuthClient`](../classes/AuthClient.md)

## Defined in [#defined-in-1026]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:567](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L567)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / createDiscoveryCache

# Function: createDiscoveryCache() [#function-creatediscoverycache]

> **createDiscoveryCache**(`cacheOptions`): `object`

One document per issuer, refetched after the TTL, with in-flight
de-duplication and stale-on-error: a document that was fetched once is
kept for as long as the issuer cannot be reached again. A fallback (known
layout) answer is not cached past the next call, so discovery is retried.

## Parameters [#parameters-75]

• **cacheOptions**: [`DiscoveryCacheOptions`](../interfaces/DiscoveryCacheOptions.md) = `{}`

## Returns [#returns-100]

`object`

### clear() [#clear-1]

> **clear**: () => `void`

#### Returns [#returns-101]

`void`

### get() [#get-1]

> **get**: (`issuer`, `options`) => `Promise`\<[`IssuerMetadata`](../interfaces/IssuerMetadata.md)> = `load`

#### Parameters [#parameters-76]

• **issuer**: `string`

• **options**: [`DiscoverOptions`](../interfaces/DiscoverOptions.md) = `{}`

#### Returns [#returns-102]

`Promise`\<[`IssuerMetadata`](../interfaces/IssuerMetadata.md)>

### peek() [#peek-1]

> **peek**: (`issuer`) => `null` | [`IssuerMetadata`](../interfaces/IssuerMetadata.md)

#### Parameters [#parameters-77]

• **issuer**: `string`

#### Returns [#returns-103]

`null` | [`IssuerMetadata`](../interfaces/IssuerMetadata.md)

## Defined in [#defined-in-1027]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:181](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L181)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / createJwksResolver

# Function: createJwksResolver() [#function-createjwksresolver]

> **createJwksResolver**(`options`): [`JwksResolver`](../interfaces/JwksResolver.md)

## Parameters [#parameters-78]

• **options**: [`JwksResolverOptions`](../interfaces/JwksResolverOptions.md)

## Returns [#returns-104]

[`JwksResolver`](../interfaces/JwksResolver.md)

## Defined in [#defined-in-1028]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:61](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L61)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / createPkcePair

# Function: createPkcePair() [#function-createpkcepair]

> **createPkcePair**(): `Promise`\<[`PkcePair`](../interfaces/PkcePair.md)>

## Returns [#returns-105]

`Promise`\<[`PkcePair`](../interfaces/PkcePair.md)>

## Defined in [#defined-in-1029]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/pkce.ts:35](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/pkce.ts#L35)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / decodeIdToken

# Function: decodeIdToken() [#function-decodeidtoken]

> **decodeIdToken**(`idToken`): [`IdTokenClaims`](../interfaces/IdTokenClaims.md)

Claims without verification. Only for display of data you already verified once (never for trust decisions).

## Parameters [#parameters-79]

• **idToken**: `string`

## Returns [#returns-106]

[`IdTokenClaims`](../interfaces/IdTokenClaims.md)

## Defined in [#defined-in-1030]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/verify.ts:79](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/verify.ts#L79)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / discover

# Function: discover() [#function-discover]

> **discover**(`issuer`, `options`): `Promise`\<[`IssuerMetadata`](../interfaces/IssuerMetadata.md)>

Fetch and validate the issuer's discovery document. Tries alternate
locations when given, then falls back to the known layout unless disabled.

## Parameters [#parameters-80]

• **issuer**: `string`

• **options**: [`DiscoverOptions`](../interfaces/DiscoverOptions.md) = `{}`

## Returns [#returns-107]

`Promise`\<[`IssuerMetadata`](../interfaces/IssuerMetadata.md)>

## Defined in [#defined-in-1031]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:165](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L165)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / embeddedKeysFor

# Function: embeddedKeysFor() [#function-embeddedkeysfor]

> **embeddedKeysFor**(`issuer`): [`JWK`](../type-aliases/JWK.md)\[]

## Parameters [#parameters-81]

• **issuer**: `string`

## Returns [#returns-108]

[`JWK`](../type-aliases/JWK.md)\[]

## Defined in [#defined-in-1032]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/embedded-keys.ts:14](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/embedded-keys.ts#L14)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / evaluateGrace

# Function: evaluateGrace() [#function-evaluategrace]

> **evaluateGrace**(`tokens`, `now`, `policy`): [`GraceVerdict`](../type-aliases/GraceVerdict.md)

Where a token set stands at `now` (epoch ms).
`active`: not expired. `grace`: expired, but inside both bounds.
`expired`: outside the grace window or past the cap.

## Parameters [#parameters-82]

• **tokens**

• **tokens.expiresAt**: `number`

• **tokens.issuedAt**: `number`

• **now**: `number`

• **policy**: `Partial`\<[`SessionGracePolicy`](../interfaces/SessionGracePolicy.md)> = `DEFAULT_GRACE_POLICY`

## Returns [#returns-109]

[`GraceVerdict`](../type-aliases/GraceVerdict.md)

## Defined in [#defined-in-1033]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/grace.ts:43](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/grace.ts#L43)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / exchangeAuthorizationCode

# Function: exchangeAuthorizationCode() [#function-exchangeauthorizationcode]

> **exchangeAuthorizationCode**(`client`, `params`): `Promise`\<[`TokenResponse`](../interfaces/TokenResponse.md)>

`grant_type=authorization_code` with PKCE.

## Parameters [#parameters-83]

• **client**: [`TokenEndpointClient`](../interfaces/TokenEndpointClient.md)

• **params**: [`CodeExchangeParams`](../interfaces/CodeExchangeParams.md)

## Returns [#returns-110]

`Promise`\<[`TokenResponse`](../interfaces/TokenResponse.md)>

## Defined in [#defined-in-1034]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:101](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L101)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / fetchUserInfo

# Function: fetchUserInfo() [#function-fetchuserinfo]

> **fetchUserInfo**(`params`): `Promise`\<`Partial`\<[`IdTokenClaims`](../interfaces/IdTokenClaims.md)> & `object`>

The userinfo endpoint answers the same claims the ID token carries, filtered by the granted scopes.

## Parameters [#parameters-84]

• **params**: [`UserInfoParams`](../interfaces/UserInfoParams.md)

## Returns [#returns-111]

`Promise`\<`Partial`\<[`IdTokenClaims`](../interfaces/IdTokenClaims.md)> & `object`>

## Defined in [#defined-in-1035]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:222](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L222)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / generateCodeVerifier

# Function: generateCodeVerifier() [#function-generatecodeverifier]

> **generateCodeVerifier**(): `string`

32 random bytes as base64url: 43 characters, inside the 43..128 range the RFC requires.

## Returns [#returns-112]

`string`

## Defined in [#defined-in-1036]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/pkce.ts:9](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/pkce.ts#L9)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / generateNonce

# Function: generateNonce() [#function-generatenonce]

> **generateNonce**(): `string`

## Returns [#returns-113]

`string`

## Defined in [#defined-in-1037]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/pkce.ts:25](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/pkce.ts#L25)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / generateState

# Function: generateState() [#function-generatestate]

> **generateState**(): `string`

## Returns [#returns-114]

`string`

## Defined in [#defined-in-1038]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/pkce.ts:21](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/pkce.ts#L21)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / graceDeadline

# Function: graceDeadline() [#function-gracedeadline]

> **graceDeadline**(`tokens`, `policy`): `number`

Epoch ms after which a set can no longer be in grace (for cookie Max-Age and timers).

## Parameters [#parameters-85]

• **tokens**

• **tokens.expiresAt**: `number`

• **tokens.issuedAt**: `number`

• **policy**: `Partial`\<[`SessionGracePolicy`](../interfaces/SessionGracePolicy.md)> = `DEFAULT_GRACE_POLICY`

## Returns [#returns-115]

`number`

## Defined in [#defined-in-1039]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/grace.ts:57](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/grace.ts#L57)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / introspectToken

# Function: introspectToken() [#function-introspecttoken]

> **introspectToken**(`params`): `Promise`\<[`IntrospectionResponse`](../interfaces/IntrospectionResponse.md)>

RFC 7662. A client may introspect its own tokens.

## Parameters [#parameters-86]

• **params**: [`IntrospectionParams`](../interfaces/IntrospectionParams.md)

## Returns [#returns-116]

`Promise`\<[`IntrospectionResponse`](../interfaces/IntrospectionResponse.md)>

## Defined in [#defined-in-1040]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:200](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L200)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / isAuthorizationResponse

# Function: isAuthorizationResponse() [#function-isauthorizationresponse]

> **isAuthorizationResponse**(`url`): `boolean`

True when `url` looks like an authorization response (a code or an error with a state).

## Parameters [#parameters-87]

• **url**: `string` | `URL`

## Returns [#returns-117]

`boolean`

## Defined in [#defined-in-1041]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:66](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L66)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / isPublicSigningJwk

# Function: isPublicSigningJwk() [#function-ispublicsigningjwk]

> **isPublicSigningJwk**(`jwk`): `jwk is JWK`

## Parameters [#parameters-88]

• **jwk**: `unknown`

## Returns [#returns-118]

`jwk is JWK`

## Defined in [#defined-in-1042]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:52](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L52)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / isSignedOutError

# Function: isSignedOutError() [#function-issignedouterror]

> **isSignedOutError**(`error`): `boolean`

## Parameters [#parameters-89]

• **error**: `unknown`

## Returns [#returns-119]

`boolean`

## Defined in [#defined-in-1043]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:101](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L101)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / isTransientError

# Function: isTransientError() [#function-istransienterror]

> **isTransientError**(`error`): `boolean`

The request did not get a usable answer: offline, DNS, timeout, a gateway
page, a 5xx or a 429. The session should be kept (grace) and the call
retried later. Never true for an OAuth error object with a 4xx status.

## Parameters [#parameters-90]

• **error**: `unknown`

## Returns [#returns-120]

`boolean`

## Defined in [#defined-in-1044]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:114](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L114)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / knownIssuerMetadata

# Function: knownIssuerMetadata() [#function-knownissuermetadata]

> **knownIssuerMetadata**(`issuer`): [`IssuerMetadata`](../interfaces/IssuerMetadata.md)

Metadata for an issuer that follows the known layout, without a network round trip.

## Parameters [#parameters-91]

• **issuer**: `string`

## Returns [#returns-121]

[`IssuerMetadata`](../interfaces/IssuerMetadata.md)

## Defined in [#defined-in-1045]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:42](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L42)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / memoryStorage

# Function: memoryStorage() [#function-memorystorage]

> **memoryStorage**(): [`AuthStorage`](../interfaces/AuthStorage.md)

## Returns [#returns-122]

[`AuthStorage`](../interfaces/AuthStorage.md)

## Defined in [#defined-in-1046]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/storage.ts:22](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/storage.ts#L22)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / oauthErrorFromBody

# Function: oauthErrorFromBody() [#function-oautherrorfrombody]

> **oauthErrorFromBody**(`body`, `status`): [`OAuthError`](../classes/OAuthError.md) | `null`

Parse an OAuth error body if that is what `body` is.

## Parameters [#parameters-92]

• **body**: `unknown`

• **status**: `number`

## Returns [#returns-123]

[`OAuthError`](../classes/OAuthError.md) | `null`

## Defined in [#defined-in-1047]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:84](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L84)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / parseAuthorizationResponse

# Function: parseAuthorizationResponse() [#function-parseauthorizationresponse]

> **parseAuthorizationResponse**(`url`, `expected`): [`AuthorizationResponse`](../interfaces/AuthorizationResponse.md)

Validate the redirect back from the issuer. Throws [OAuthError](../classes/OAuthError.md) for
an error response (after checking `state`), [AuthError](../classes/AuthError.md)
`invalid_state` when the state does not match, `invalid_callback` when
there is neither code nor error, and `invalid_response` when an `iss` is
present but wrong (mix-up defence).

## Parameters [#parameters-93]

• **url**: `string` | `URL`

• **expected**

• &#x2A;*expected.issuer?**: `string`

• **expected.state**: `string`

## Returns [#returns-124]

[`AuthorizationResponse`](../interfaces/AuthorizationResponse.md)

## Defined in [#defined-in-1048]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:79](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L79)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / pollDeviceToken

# Function: pollDeviceToken() [#function-polldevicetoken]

> **pollDeviceToken**(`params`): `Promise`\<[`TokenResponse`](../interfaces/TokenResponse.md)>

Poll the token endpoint until the user approves. Honours
`authorization_pending` (wait), `slow_down` (wait 5 s more each time),
`expired_token` (`device_flow_expired`) and `access_denied`.

## Parameters [#parameters-94]

• **params**: [`DevicePollParams`](../interfaces/DevicePollParams.md)

## Returns [#returns-125]

`Promise`\<[`TokenResponse`](../interfaces/TokenResponse.md)>

## Defined in [#defined-in-1049]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:66](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L66)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / refreshTokenGrant

# Function: refreshTokenGrant() [#function-refreshtokengrant]

> **refreshTokenGrant**(`client`, `params`): `Promise`\<[`TokenResponse`](../interfaces/TokenResponse.md)>

`grant_type=refresh_token`. The issuer ALWAYS rotates: the answer carries
a new refresh token and the presented one is dead. Presenting it again
revokes the whole grant. Use [RefreshCoordinator](../classes/RefreshCoordinator.md) rather than
calling this directly from application code.

## Parameters [#parameters-95]

• **client**: [`TokenEndpointClient`](../interfaces/TokenEndpointClient.md)

• **params**: [`RefreshParams`](../interfaces/RefreshParams.md)

## Returns [#returns-126]

`Promise`\<[`TokenResponse`](../interfaces/TokenResponse.md)>

## Defined in [#defined-in-1050]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:131](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L131)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / resolveGracePolicy

# Function: resolveGracePolicy() [#function-resolvegracepolicy]

> **resolveGracePolicy**(`policy`): [`SessionGracePolicy`](../interfaces/SessionGracePolicy.md)

## Parameters [#parameters-96]

• **policy**: `undefined` | `Partial`\<[`SessionGracePolicy`](../interfaces/SessionGracePolicy.md)>

## Returns [#returns-127]

[`SessionGracePolicy`](../interfaces/SessionGracePolicy.md)

## Defined in [#defined-in-1051]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/grace.ts:34](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/grace.ts#L34)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / resolveStorage

# Function: resolveStorage() [#function-resolvestorage]

> **resolveStorage**(`kind`, `fallback`): [`AuthStorage`](../interfaces/AuthStorage.md)

## Parameters [#parameters-97]

• **kind**: `undefined` | [`AuthStorage`](../interfaces/AuthStorage.md) | [`StorageKind`](../type-aliases/StorageKind.md)

• **fallback**: [`StorageKind`](../type-aliases/StorageKind.md)

## Returns [#returns-128]

[`AuthStorage`](../interfaces/AuthStorage.md)

## Defined in [#defined-in-1052]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/storage.ts:78](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/storage.ts#L78)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / revokeToken

# Function: revokeToken() [#function-revoketoken]

> **revokeToken**(`params`): `Promise`\<`void`>

RFC 7009. Revoking a refresh token ends every token of its grant. Unknown tokens answer 200.

## Parameters [#parameters-98]

• **params**: [`RevocationParams`](../interfaces/RevocationParams.md)

## Returns [#returns-129]

`Promise`\<`void`>

## Defined in [#defined-in-1053]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:158](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L158)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / shortWallet

# Function: shortWallet() [#function-shortwallet]

> **shortWallet**(`walletOrDid`): `string`

`0x1234...abcd` for a wallet address or did:pkh.

## Parameters [#parameters-99]

• **walletOrDid**: `string`

## Returns [#returns-130]

`string`

## Defined in [#defined-in-1054]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/claims.ts:53](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/claims.ts#L53)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / startDeviceAuthorization

# Function: startDeviceAuthorization() [#function-startdeviceauthorization]

> **startDeviceAuthorization**(`params`): `Promise`\<[`DeviceAuthorizationResponse`](../interfaces/DeviceAuthorizationResponse.md)>

## Parameters [#parameters-100]

• **params**: [`DeviceAuthorizationParams`](../interfaces/DeviceAuthorizationParams.md)

## Returns [#returns-131]

`Promise`\<[`DeviceAuthorizationResponse`](../interfaces/DeviceAuthorizationResponse.md)>

## Defined in [#defined-in-1055]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:26](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L26)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / tokenSetFromResponse

# Function: tokenSetFromResponse() [#function-tokensetfromresponse]

> **tokenSetFromResponse**(`response`, `options`): [`TokenSet`](../interfaces/TokenSet.md)

Normalize a token response into absolute times. `claims` are attached by the caller after verification.

## Parameters [#parameters-101]

• **response**: [`TokenResponse`](../interfaces/TokenResponse.md)

• **options** = `{}`

• &#x2A;*options.claims?**: `null` | [`IdTokenClaims`](../interfaces/IdTokenClaims.md)

• &#x2A;*options.defaultExpiresInSeconds?**: `number`

• &#x2A;*options.now?**: `number`

## Returns [#returns-132]

[`TokenSet`](../interfaces/TokenSet.md)

## Defined in [#defined-in-1056]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:246](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L246)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / userFromClaims

# Function: userFromClaims() [#function-userfromclaims]

> **userFromClaims**(`claims`): [`AuthUser`](../interfaces/AuthUser.md)

Build the [AuthUser](../interfaces/AuthUser.md) an app stores. `key` is the wallet DID when the
user has a verified wallet, otherwise the subject: wallet-anchored
identities survive a change of issuer.

## Parameters [#parameters-102]

• **claims**: `Pick`\<[`IdTokenClaims`](../interfaces/IdTokenClaims.md), `"sub"`> & `Partial`\<[`IdTokenClaims`](../interfaces/IdTokenClaims.md)>

## Returns [#returns-133]

[`AuthUser`](../interfaces/AuthUser.md)

## Defined in [#defined-in-1057]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/claims.ts:18](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/claims.ts#L18)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / userInitials

# Function: userInitials() [#function-userinitials]

> **userInitials**(`user`): `string`

Initials for an avatar fallback: two letters from the name, else one from the email, else the wallet's first hex digits.

## Parameters [#parameters-103]

• **user**: `Pick`\<[`AuthUser`](../interfaces/AuthUser.md), `"name"` | `"email"` | `"wallet"`>

## Returns [#returns-134]

`string`

## Defined in [#defined-in-1058]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/claims.ts:36](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/claims.ts#L36)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / verifyIdToken

# Function: verifyIdToken() [#function-verifyidtoken]

> **verifyIdToken**(`idToken`, `options`): `Promise`\<[`IdTokenClaims`](../interfaces/IdTokenClaims.md)>

## Parameters [#parameters-104]

• **idToken**: `string`

• **options**: [`VerifyIdTokenOptions`](../interfaces/VerifyIdTokenOptions.md)

## Returns [#returns-135]

`Promise`\<[`IdTokenClaims`](../interfaces/IdTokenClaims.md)>

## Defined in [#defined-in-1059]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/verify.ts:29](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/verify.ts#L29)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / webStorage

# Function: webStorage() [#function-webstorage]

> **webStorage**(`kind`): [`AuthStorage`](../interfaces/AuthStorage.md)

`sessionStorage` or `localStorage` with a memory fallback when the area is unavailable.

## Parameters [#parameters-105]

• **kind**: `"session"` | `"local"`

## Returns [#returns-136]

[`AuthStorage`](../interfaces/AuthStorage.md)

## Defined in [#defined-in-1060]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/storage.ts:50](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/storage.ts#L50)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / withLock

# Function: withLock() [#function-withlock]

> **withLock**\<`T`>(`name`, `fn`): `Promise`\<`T`>

Run `fn` under a cross-tab lock when the Web Locks API exists (so two tabs
sharing `localStorage` never refresh the same token twice), else directly.

## Type Parameters [#type-parameters-2]

• **T**

## Parameters [#parameters-106]

• **name**: `string`

• **fn**

## Returns [#returns-137]

`Promise`\<`T`>

## Defined in [#defined-in-1061]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/storage.ts:89](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/storage.ts#L89)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / AuthClientOptions

# Interface: AuthClientOptions [#interface-authclientoptions]

## Properties [#properties-23]

### alternateDiscoveryLocations? [#alternatediscoverylocations]

> `optional` **alternateDiscoveryLocations**: `string`\[]

Mirrors of the discovery document (plan M4).

#### Defined in [#defined-in-1062]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:48](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L48)

***

### clientAuthentication? [#clientauthentication]

> `optional` **clientAuthentication**: [`ClientAuthentication`](../type-aliases/ClientAuthentication.md)

Default `{ method: 'none' }`. Confidential clients belong on a server; never ship a secret to a browser.

#### Defined in [#defined-in-1063]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:42](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L42)

***

### clientId [#clientid-3]

> **clientId**: `string`

#### Defined in [#defined-in-1064]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:36](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L36)

***

### clockToleranceSeconds? [#clocktoleranceseconds]

> `optional` **clockToleranceSeconds**: `number`

#### Defined in [#defined-in-1065]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:63](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L63)

***

### embeddedKeys? [#embeddedkeys-1]

> `optional` **embeddedKeys**: readonly [`JWK`](../type-aliases/JWK.md)\[]

Public keys to trust before the first JWKS fetch. Default: the snapshot embedded at build time for this issuer.

#### Defined in [#defined-in-1066]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:59](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L59)

***

### fetch? [#fetch-1]

> `optional` **fetch**: [`FetchLike`](../type-aliases/FetchLike.md)

#### Defined in [#defined-in-1067]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:49](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L49)

***

### grace? [#grace-1]

> `optional` **grace**: `false` | `Partial`\<[`SessionGracePolicy`](SessionGracePolicy.md)>

Grace policy for an unreachable issuer. `false` disables grace.

#### Defined in [#defined-in-1068]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:57](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L57)

***

### issuer? [#issuer-3]

> `optional` **issuer**: `string`

Issuer identifier. Default the production issuer.

#### Defined in [#defined-in-1069]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:35](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L35)

***

### jwksTtlMs? [#jwksttlms]

> `optional` **jwksTtlMs**: `number`

#### Defined in [#defined-in-1070]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:60](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L60)

***

### metadata? [#metadata-3]

> `optional` **metadata**: [`IssuerMetadata`](IssuerMetadata.md)

Skip discovery entirely.

#### Defined in [#defined-in-1071]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:46](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L46)

***

### navigate()? [#navigate]

> `optional` **navigate**: (`url`) => `void`

How to leave the page. Default `window.location.assign`.

#### Parameters [#parameters-107]

• **url**: `string`

#### Returns [#returns-138]

`void`

#### Defined in [#defined-in-1072]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:69](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L69)

***

### now()? [#now-1]

> `optional` **now**: () => `number`

#### Returns [#returns-139]

`number`

#### Defined in [#defined-in-1073]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:66](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L66)

***

### onWarning()? [#onwarning-1]

> `optional` **onWarning**: (`message`, `cause`?) => `void`

#### Parameters [#parameters-108]

• **message**: `string`

• &#x2A;*cause?**: `unknown`

#### Returns [#returns-140]

`void`

#### Defined in [#defined-in-1074]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:67](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L67)

***

### postLogoutRedirectUri? [#postlogoutredirecturi-1]

> `optional` **postLogoutRedirectUri**: `string`

Registered post-logout redirect URI used by `signOut({ redirect: true })`.

#### Defined in [#defined-in-1075]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:44](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L44)

***

### redirectUri [#redirecturi-2]

> **redirectUri**: `string`

Must be registered on the client, exactly.

#### Defined in [#defined-in-1076]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:38](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L38)

***

### refreshLeewayMs? [#refreshleewayms-1]

> `optional` **refreshLeewayMs**: `number`

Refresh this long before the access token expires. Default 30 s.

#### Defined in [#defined-in-1077]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:62](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L62)

***

### scope? [#scope-7]

> `optional` **scope**: `string` | readonly `string`\[]

Default `openid profile email`. Add `org` for the organization picker and `wallet` for wallet claims.

#### Defined in [#defined-in-1078]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:40](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L40)

***

### sessionStorage? [#sessionstorage]

> `optional` **sessionStorage**: [`AuthStorage`](AuthStorage.md) | [`StorageKind`](../type-aliases/StorageKind.md)

Where tokens live. Default `memory`.

#### Defined in [#defined-in-1079]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:51](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L51)

***

### storageKeyPrefix? [#storagekeyprefix]

> `optional` **storageKeyPrefix**: `string`

Prefix for storage keys. Default `af_auth.<clientId>`.

#### Defined in [#defined-in-1080]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:55](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L55)

***

### transactionStorage? [#transactionstorage]

> `optional` **transactionStorage**: [`AuthStorage`](AuthStorage.md) | [`StorageKind`](../type-aliases/StorageKind.md)

Where the pending sign-in lives across the redirect. Default `session` (sessionStorage), memory outside a browser.

#### Defined in [#defined-in-1081]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:53](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L53)

***

### transactionTtlMs? [#transactionttlms]

> `optional` **transactionTtlMs**: `number`

Pending sign-ins older than this are discarded. Default 15 min.

#### Defined in [#defined-in-1082]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:65](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L65)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / AuthStorage

# Interface: AuthStorage [#interface-authstorage]

Where the client keeps its state. Two stores:

* transaction store: the pending sign-in (state, nonce, PKCE verifier,
  return path). It must survive the redirect to the issuer and back, so
  in a browser it defaults to `sessionStorage`.
* session store: the tokens. Defaults to memory (lost on reload; the
  next click on the sign-in button comes straight back because consent is
  remembered). `session` keeps them per tab, `local` shares them between
  tabs; both are readable by any script on the origin, so prefer a
  server-side (BFF) session when the app has a server.

## Methods [#methods-9]

### get() [#get-2]

> **get**(`key`): `null` | `string`

#### Parameters [#parameters-109]

• **key**: `string`

#### Returns [#returns-141]

`null` | `string`

#### Defined in [#defined-in-1083]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/storage.ts:15](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/storage.ts#L15)

***

### remove() [#remove]

> **remove**(`key`): `void`

#### Parameters [#parameters-110]

• **key**: `string`

#### Returns [#returns-142]

`void`

#### Defined in [#defined-in-1084]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/storage.ts:17](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/storage.ts#L17)

***

### set() [#set]

> **set**(`key`, `value`): `void`

#### Parameters [#parameters-111]

• **key**: `string`

• **value**: `string`

#### Returns [#returns-143]

`void`

#### Defined in [#defined-in-1085]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/storage.ts:16](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/storage.ts#L16)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / AuthUser

# Interface: AuthUser [#interface-authuser]

The signed-in user as an application sees it. Derived from ID token claims by [userFromClaims](../functions/userFromClaims.md).

## Properties [#properties-24]

### email [#email]

> **email**: `null` | `string`

#### Defined in [#defined-in-1086]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:90](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L90)

***

### emailVerified [#emailverified]

> **emailVerified**: `boolean`

#### Defined in [#defined-in-1087]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:91](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L91)

***

### id [#id-3]

> **id**: `string`

The issuer subject (`sub`): the account id, pairwise per client when the client opted in.

#### Defined in [#defined-in-1088]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:88](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L88)

***

### key [#key-2]

> **key**: `string`

The key to store the local user under. The wallet DID when the user has
a verified wallet, otherwise the issuer subject. A wallet-anchored key
survives an issuer replacement (plan §3, §4 M4); a `sub` does not.

#### Defined in [#defined-in-1089]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:86](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L86)

***

### name [#name-6]

> **name**: `null` | `string`

#### Defined in [#defined-in-1090]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:89](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L89)

***

### org [#org]

> **org**: `null` | [`OrganizationClaim`](OrganizationClaim.md)

#### Defined in [#defined-in-1091]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:95](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L95)

***

### picture [#picture]

> **picture**: `null` | `string`

#### Defined in [#defined-in-1092]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:92](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L92)

***

### updatedAt [#updatedat]

> **updatedAt**: `null` | `Date`

#### Defined in [#defined-in-1093]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:96](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L96)

***

### wallet [#wallet]

> **wallet**: `null` | `string`

#### Defined in [#defined-in-1094]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:93](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L93)

***

### wallets [#wallets]

> **wallets**: `string`\[]

#### Defined in [#defined-in-1095]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:94](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L94)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / AuthorizationRequestParams

# Interface: AuthorizationRequestParams [#interface-authorizationrequestparams]

## Properties [#properties-25]

### clientId [#clientid-4]

> **clientId**: `string`

#### Defined in [#defined-in-1096]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:17](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L17)

***

### codeChallenge [#codechallenge]

> **codeChallenge**: `string`

#### Defined in [#defined-in-1097]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:23](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L23)

***

### extraParams? [#extraparams]

> `optional` **extraParams**: `Record`\<`string`, `string`>

Anything else, verbatim (`ui_locales`, `max_age`, ...).

#### Defined in [#defined-in-1098]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:30](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L30)

***

### loginHint? [#loginhint-3]

> `optional` **loginHint**: `string`

#### Defined in [#defined-in-1099]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:26](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L26)

***

### metadata [#metadata-4]

> **metadata**: `Pick`\<[`IssuerMetadata`](IssuerMetadata.md), `"authorization_endpoint"`>

#### Defined in [#defined-in-1100]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:16](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L16)

***

### nonce [#nonce-2]

> **nonce**: `string`

#### Defined in [#defined-in-1101]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:22](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L22)

***

### prompt? [#prompt-3]

> `optional` **prompt**: `"none"` | `"login"` | `"consent"` | `"select_account"`

`login` forces the sign-in page; `consent` re-asks; `none` is not supported by the issuer yet (M3).

#### Defined in [#defined-in-1102]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:25](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L25)

***

### redirectUri [#redirecturi-3]

> **redirectUri**: `string`

#### Defined in [#defined-in-1103]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:18](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L18)

***

### resource? [#resource-1]

> `optional` **resource**: `string`

Resource indicator (RFC 8707). Only first-party clients may name the platform API.

#### Defined in [#defined-in-1104]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:28](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L28)

***

### scope? [#scope-8]

> `optional` **scope**: `string` | readonly `string`\[]

Space-separated string or list. `openid` is added when missing. Default `openid profile email`.

#### Defined in [#defined-in-1105]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:20](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L20)

***

### state [#state-1]

> **state**: `string`

#### Defined in [#defined-in-1106]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:21](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L21)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / AuthorizationResponse

# Interface: AuthorizationResponse [#interface-authorizationresponse]

## Properties [#properties-26]

### code [#code-2]

> **code**: `string`

#### Defined in [#defined-in-1107]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:52](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L52)

***

### iss [#iss]

> **iss**: `null` | `string`

Present when the issuer echoes its identifier (RFC 9207).

#### Defined in [#defined-in-1108]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:55](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L55)

***

### state [#state-2]

> **state**: `string`

#### Defined in [#defined-in-1109]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:53](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L53)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / CallbackResult

# Interface: CallbackResult [#interface-callbackresult]

## Properties [#properties-27]

### returnTo [#returnto-5]

> **returnTo**: `null` | `string`

#### Defined in [#defined-in-1110]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:85](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L85)

***

### session [#session-3]

> **session**: [`Session`](Session.md)

#### Defined in [#defined-in-1111]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:84](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L84)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / CodeExchangeParams

# Interface: CodeExchangeParams [#interface-codeexchangeparams]

## Properties [#properties-28]

### code [#code-3]

> **code**: `string`

#### Defined in [#defined-in-1112]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:94](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L94)

***

### codeVerifier [#codeverifier]

> **codeVerifier**: `string`

#### Defined in [#defined-in-1113]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:96](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L96)

***

### redirectUri [#redirecturi-4]

> **redirectUri**: `string`

#### Defined in [#defined-in-1114]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:95](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L95)

***

### resource? [#resource-2]

> `optional` **resource**: `string`

#### Defined in [#defined-in-1115]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:97](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L97)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / DeviceAuthorizationParams

# Interface: DeviceAuthorizationParams [#interface-deviceauthorizationparams]

## Properties [#properties-29]

### clientAuthentication? [#clientauthentication-1]

> `optional` **clientAuthentication**: [`ClientAuthentication`](../type-aliases/ClientAuthentication.md)

#### Defined in [#defined-in-1116]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:20](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L20)

***

### clientId [#clientid-5]

> **clientId**: `string`

#### Defined in [#defined-in-1117]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:19](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L19)

***

### fetch? [#fetch-2]

> `optional` **fetch**: [`FetchLike`](../type-aliases/FetchLike.md)

#### Defined in [#defined-in-1118]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:22](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L22)

***

### metadata [#metadata-5]

> **metadata**: `Pick`\<[`IssuerMetadata`](IssuerMetadata.md), `"device_authorization_endpoint"` | `"token_endpoint"`>

#### Defined in [#defined-in-1119]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:18](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L18)

***

### scope? [#scope-9]

> `optional` **scope**: `string` | readonly `string`\[]

#### Defined in [#defined-in-1120]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:21](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L21)

***

### timeoutMs? [#timeoutms]

> `optional` **timeoutMs**: `number`

#### Defined in [#defined-in-1121]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:23](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L23)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / DeviceAuthorizationResponse

# Interface: DeviceAuthorizationResponse [#interface-deviceauthorizationresponse]

RFC 8628 §3.2 device authorization response.

## Indexable [#indexable]

\[`key`: `string`]: `unknown`

## Properties [#properties-30]

### device\_code [#device_code]

> **device\_code**: `string`

#### Defined in [#defined-in-1122]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:140](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L140)

***

### expires\_in [#expires_in]

> **expires\_in**: `number`

#### Defined in [#defined-in-1123]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:144](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L144)

***

### interval? [#interval]

> `optional` **interval**: `number`

#### Defined in [#defined-in-1124]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:145](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L145)

***

### user\_code [#user_code]

> **user\_code**: `string`

#### Defined in [#defined-in-1125]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:141](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L141)

***

### verification\_uri [#verification_uri]

> **verification\_uri**: `string`

#### Defined in [#defined-in-1126]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:142](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L142)

***

### verification\_uri\_complete? [#verification_uri_complete]

> `optional` **verification\_uri\_complete**: `string`

#### Defined in [#defined-in-1127]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:143](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L143)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / DevicePollParams

# Interface: DevicePollParams [#interface-devicepollparams]

## Properties [#properties-31]

### clientAuthentication? [#clientauthentication-2]

> `optional` **clientAuthentication**: [`ClientAuthentication`](../type-aliases/ClientAuthentication.md)

#### Defined in [#defined-in-1128]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:45](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L45)

***

### clientId [#clientid-6]

> **clientId**: `string`

#### Defined in [#defined-in-1129]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:44](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L44)

***

### deviceCode [#devicecode]

> **deviceCode**: `string`

#### Defined in [#defined-in-1130]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:46](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L46)

***

### expiresInSeconds? [#expiresinseconds]

> `optional` **expiresInSeconds**: `number`

Give up after this many seconds; the issuer's `expires_in`.

#### Defined in [#defined-in-1131]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:50](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L50)

***

### fetch? [#fetch-3]

> `optional` **fetch**: [`FetchLike`](../type-aliases/FetchLike.md)

#### Defined in [#defined-in-1132]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:52](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L52)

***

### intervalSeconds? [#intervalseconds]

> `optional` **intervalSeconds**: `number`

Seconds between polls; the issuer's `interval` (default 5).

#### Defined in [#defined-in-1133]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:48](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L48)

***

### metadata [#metadata-6]

> **metadata**: `Pick`\<[`IssuerMetadata`](IssuerMetadata.md), `"token_endpoint"`>

#### Defined in [#defined-in-1134]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:43](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L43)

***

### now()? [#now-2]

> `optional` **now**: () => `number`

#### Returns [#returns-144]

`number`

#### Defined in [#defined-in-1135]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:58](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L58)

***

### onPending()? [#onpending]

> `optional` **onPending**: (`waitSeconds`) => `void`

Called before each wait with the seconds about to be slept (progress UI).

#### Parameters [#parameters-112]

• **waitSeconds**: `number`

#### Returns [#returns-145]

`void`

#### Defined in [#defined-in-1136]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:55](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L55)

***

### signal? [#signal]

> `optional` **signal**: `AbortSignal`

#### Defined in [#defined-in-1137]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:51](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L51)

***

### sleep()? [#sleep]

> `optional` **sleep**: (`ms`, `signal`?) => `Promise`\<`void`>

Injectable for tests.

#### Parameters [#parameters-113]

• **ms**: `number`

• &#x2A;*signal?**: `AbortSignal`

#### Returns [#returns-146]

`Promise`\<`void`>

#### Defined in [#defined-in-1138]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:57](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L57)

***

### timeoutMs? [#timeoutms-1]

> `optional` **timeoutMs**: `number`

#### Defined in [#defined-in-1139]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:53](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L53)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / DiscoverOptions

# Interface: DiscoverOptions [#interface-discoveroptions]

## Properties [#properties-32]

### alternateLocations? [#alternatelocations]

> `optional` **alternateLocations**: `string`\[]

Other base URLs that mirror the discovery document (a second domain, an
onion service, an IPFS gateway; plan §4 M4). Tried in order after the
issuer itself. The mirrored document must still name the canonical issuer.

#### Defined in [#defined-in-1140]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:81](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L81)

***

### fallbackToKnownLayout? [#fallbacktoknownlayout]

> `optional` **fallbackToKnownLayout**: `boolean`

When the document cannot be fetched (network, gateway page, 5xx), answer
with [knownIssuerMetadata](../functions/knownIssuerMetadata.md) instead of throwing. Default true. A
document that IS fetched but names another issuer always throws.

#### Defined in [#defined-in-1141]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:75](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L75)

***

### fetch? [#fetch-4]

> `optional` **fetch**: [`FetchLike`](../type-aliases/FetchLike.md)

#### Defined in [#defined-in-1142]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:66](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L66)

***

### onWarning()? [#onwarning-2]

> `optional` **onWarning**: (`message`, `cause`?) => `void`

#### Parameters [#parameters-114]

• **message**: `string`

• &#x2A;*cause?**: `unknown`

#### Returns [#returns-147]

`void`

#### Defined in [#defined-in-1143]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:82](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L82)

***

### signal? [#signal-1]

> `optional` **signal**: `AbortSignal`

#### Defined in [#defined-in-1144]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:67](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L67)

***

### timeoutMs? [#timeoutms-2]

> `optional` **timeoutMs**: `number`

Per request. Default 10 s.

#### Defined in [#defined-in-1145]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:69](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L69)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / DiscoveryCacheOptions

# Interface: DiscoveryCacheOptions [#interface-discoverycacheoptions]

## Properties [#properties-33]

### now()? [#now-3]

> `optional` **now**: () => `number`

#### Returns [#returns-148]

`number`

#### Defined in [#defined-in-1146]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:172](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L172)

***

### ttlMs? [#ttlms]

> `optional` **ttlMs**: `number`

How long a fetched document is reused. Default 1 hour.

#### Defined in [#defined-in-1147]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:171](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L171)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / EndSessionParams

# Interface: EndSessionParams [#interface-endsessionparams]

## Properties [#properties-34]

### clientId? [#clientid-7]

> `optional` **clientId**: `string`

#### Defined in [#defined-in-1148]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:115](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L115)

***

### idTokenHint? [#idtokenhint]

> `optional` **idTokenHint**: `null` | `string`

The ID token of the session to end. The issuer renders a confirm page without it.

#### Defined in [#defined-in-1149]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:114](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L114)

***

### metadata [#metadata-7]

> **metadata**: `Pick`\<[`IssuerMetadata`](IssuerMetadata.md), `"end_session_endpoint"`>

#### Defined in [#defined-in-1150]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:112](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L112)

***

### postLogoutRedirectUri? [#postlogoutredirecturi-2]

> `optional` **postLogoutRedirectUri**: `string`

Must be registered on the client.

#### Defined in [#defined-in-1151]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:117](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L117)

***

### state? [#state-3]

> `optional` **state**: `string`

#### Defined in [#defined-in-1152]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/authorize.ts:118](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/authorize.ts#L118)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / IdTokenClaims

# Interface: IdTokenClaims [#interface-idtokenclaims]

## Indexable [#indexable-1]

\[`key`: `string`]: `unknown`

## Properties [#properties-35]

### at\_hash? [#at_hash]

> `optional` **at\_hash**: `string`

#### Defined in [#defined-in-1153]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:61](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L61)

***

### aud [#aud]

> **aud**: `string` | `string`\[]

#### Defined in [#defined-in-1154]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:56](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L56)

***

### auth\_time? [#auth_time]

> `optional` **auth\_time**: `number`

#### Defined in [#defined-in-1155]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:59](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L59)

***

### azp? [#azp]

> `optional` **azp**: `string`

#### Defined in [#defined-in-1156]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:62](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L62)

***

### email? [#email-1]

> `optional` **email**: `string`

`email` scope

#### Defined in [#defined-in-1157]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:69](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L69)

***

### email\_verified? [#email_verified]

> `optional` **email\_verified**: `boolean`

#### Defined in [#defined-in-1158]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:70](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L70)

***

### exp [#exp]

> **exp**: `number`

#### Defined in [#defined-in-1159]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:57](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L57)

***

### iat [#iat]

> **iat**: `number`

#### Defined in [#defined-in-1160]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:58](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L58)

***

### iss [#iss-1]

> **iss**: `string`

#### Defined in [#defined-in-1161]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:54](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L54)

***

### name? [#name-7]

> `optional` **name**: `string`

`profile` scope

#### Defined in [#defined-in-1162]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:65](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L65)

***

### nonce? [#nonce-3]

> `optional` **nonce**: `string`

#### Defined in [#defined-in-1163]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:60](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L60)

***

### org? [#org-1]

> `optional` **org**: [`OrganizationClaim`](OrganizationClaim.md)

`org` scope

#### Defined in [#defined-in-1164]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:72](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L72)

***

### picture? [#picture-1]

> `optional` **picture**: `string`

#### Defined in [#defined-in-1165]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:66](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L66)

***

### sid? [#sid]

> `optional` **sid**: `string`

#### Defined in [#defined-in-1166]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:63](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L63)

***

### sub [#sub]

> **sub**: `string`

#### Defined in [#defined-in-1167]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:55](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L55)

***

### updated\_at? [#updated_at]

> `optional` **updated\_at**: `number`

#### Defined in [#defined-in-1168]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:67](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L67)

***

### wallet? [#wallet-1]

> `optional` **wallet**: `string`

`wallet` scope: `did:pkh:eip155:1:<address>` of the primary verified wallet, and every verified address.

#### Defined in [#defined-in-1169]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:74](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L74)

***

### wallets? [#wallets-1]

> `optional` **wallets**: `string`\[]

#### Defined in [#defined-in-1170]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:75](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L75)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / IntrospectionParams

# Interface: IntrospectionParams [#interface-introspectionparams]

## Properties [#properties-36]

### clientAuthentication? [#clientauthentication-3]

> `optional` **clientAuthentication**: [`ClientAuthentication`](../type-aliases/ClientAuthentication.md)

#### Defined in [#defined-in-1171]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:180](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L180)

***

### clientId [#clientid-8]

> **clientId**: `string`

#### Defined in [#defined-in-1172]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:179](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L179)

***

### fetch? [#fetch-5]

> `optional` **fetch**: [`FetchLike`](../type-aliases/FetchLike.md)

#### Defined in [#defined-in-1173]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:183](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L183)

***

### introspectionEndpoint [#introspectionendpoint]

> **introspectionEndpoint**: `string`

#### Defined in [#defined-in-1174]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:178](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L178)

***

### timeoutMs? [#timeoutms-3]

> `optional` **timeoutMs**: `number`

#### Defined in [#defined-in-1175]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:184](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L184)

***

### token [#token-1]

> **token**: `string`

#### Defined in [#defined-in-1176]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:181](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L181)

***

### tokenTypeHint? [#tokentypehint]

> `optional` **tokenTypeHint**: `"access_token"` | `"refresh_token"`

#### Defined in [#defined-in-1177]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:182](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L182)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / IntrospectionResponse

# Interface: IntrospectionResponse [#interface-introspectionresponse]

## Indexable [#indexable-2]

\[`key`: `string`]: `unknown`

## Properties [#properties-37]

### active [#active]

> **active**: `boolean`

#### Defined in [#defined-in-1178]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:188](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L188)

***

### client\_id? [#client_id]

> `optional` **client\_id**: `string`

#### Defined in [#defined-in-1179]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:190](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L190)

***

### exp? [#exp-1]

> `optional` **exp**: `number`

#### Defined in [#defined-in-1180]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:192](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L192)

***

### iat? [#iat-1]

> `optional` **iat**: `number`

#### Defined in [#defined-in-1181]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:193](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L193)

***

### iss? [#iss-2]

> `optional` **iss**: `string`

#### Defined in [#defined-in-1182]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:194](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L194)

***

### scope? [#scope-10]

> `optional` **scope**: `string`

#### Defined in [#defined-in-1183]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:189](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L189)

***

### sub? [#sub-1]

> `optional` **sub**: `string`

#### Defined in [#defined-in-1184]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:191](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L191)

***

### token\_type? [#token_type]

> `optional` **token\_type**: `string`

#### Defined in [#defined-in-1185]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:195](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L195)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / IssuerMetadata

# Interface: IssuerMetadata [#interface-issuermetadata]

OpenID Connect discovery document (RFC 8414 / OIDC Discovery 1.0), the fields the SDK relies on plus passthrough.

## Indexable [#indexable-3]

\[`key`: `string`]: `unknown`

## Properties [#properties-38]

### authorization\_endpoint [#authorization_endpoint]

> **authorization\_endpoint**: `string`

#### Defined in [#defined-in-1186]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:11](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L11)

***

### authorization\_response\_iss\_parameter\_supported? [#authorization_response_iss_parameter_supported]

> `optional` **authorization\_response\_iss\_parameter\_supported**: `boolean`

#### Defined in [#defined-in-1187]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:28](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L28)

***

### claims\_supported? [#claims_supported]

> `optional` **claims\_supported**: `string`\[]

#### Defined in [#defined-in-1188]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:27](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L27)

***

### code\_challenge\_methods\_supported? [#code_challenge_methods_supported]

> `optional` **code\_challenge\_methods\_supported**: `string`\[]

#### Defined in [#defined-in-1189]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:23](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L23)

***

### device\_authorization\_endpoint? [#device_authorization_endpoint]

> `optional` **device\_authorization\_endpoint**: `string`

#### Defined in [#defined-in-1190]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:18](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L18)

***

### end\_session\_endpoint? [#end_session_endpoint]

> `optional` **end\_session\_endpoint**: `string`

#### Defined in [#defined-in-1191]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:15](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L15)

***

### grant\_types\_supported? [#grant_types_supported]

> `optional` **grant\_types\_supported**: `string`\[]

#### Defined in [#defined-in-1192]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:22](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L22)

***

### id\_token\_signing\_alg\_values\_supported? [#id_token_signing_alg_values_supported]

> `optional` **id\_token\_signing\_alg\_values\_supported**: `string`\[]

#### Defined in [#defined-in-1193]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:24](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L24)

***

### introspection\_endpoint? [#introspection_endpoint]

> `optional` **introspection\_endpoint**: `string`

#### Defined in [#defined-in-1194]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:17](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L17)

***

### issuer [#issuer-4]

> **issuer**: `string`

#### Defined in [#defined-in-1195]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:10](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L10)

***

### jwks\_uri [#jwks_uri]

> **jwks\_uri**: `string`

#### Defined in [#defined-in-1196]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:13](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L13)

***

### response\_modes\_supported? [#response_modes_supported]

> `optional` **response\_modes\_supported**: `string`\[]

#### Defined in [#defined-in-1197]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:21](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L21)

***

### response\_types\_supported? [#response_types_supported]

> `optional` **response\_types\_supported**: `string`\[]

#### Defined in [#defined-in-1198]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:20](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L20)

***

### revocation\_endpoint? [#revocation_endpoint]

> `optional` **revocation\_endpoint**: `string`

#### Defined in [#defined-in-1199]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:16](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L16)

***

### scopes\_supported? [#scopes_supported]

> `optional` **scopes\_supported**: `string`\[]

#### Defined in [#defined-in-1200]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:19](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L19)

***

### subject\_types\_supported? [#subject_types_supported]

> `optional` **subject\_types\_supported**: `string`\[]

#### Defined in [#defined-in-1201]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:26](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L26)

***

### token\_endpoint [#token_endpoint]

> **token\_endpoint**: `string`

#### Defined in [#defined-in-1202]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:12](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L12)

***

### token\_endpoint\_auth\_methods\_supported? [#token_endpoint_auth_methods_supported]

> `optional` **token\_endpoint\_auth\_methods\_supported**: `string`\[]

#### Defined in [#defined-in-1203]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:25](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L25)

***

### userinfo\_endpoint? [#userinfo_endpoint]

> `optional` **userinfo\_endpoint**: `string`

#### Defined in [#defined-in-1204]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:14](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L14)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / JwksResolver

# Interface: JwksResolver [#interface-jwksresolver]

## Methods [#methods-10]

### getKey() [#getkey]

> **getKey**(`header`): `Promise`\<`CryptoKey`>

Resolve the key a token header names. Throws `invalid_id_token` when no published key matches.

#### Parameters [#parameters-115]

• **header**

• &#x2A;*header.alg?**: `string`

• &#x2A;*header.kid?**: `string`

#### Returns [#returns-149]

`Promise`\<`CryptoKey`>

#### Defined in [#defined-in-1205]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:42](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L42)

***

### keys() [#keys]

> **keys**(): `Promise`\<[`JWK`](../type-aliases/JWK.md)\[]>

The keys currently trusted, fetching if nothing is cached.

#### Returns [#returns-150]

`Promise`\<[`JWK`](../type-aliases/JWK.md)\[]>

#### Defined in [#defined-in-1206]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:44](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L44)

***

### refresh() [#refresh-4]

> **refresh**(): `Promise`\<[`JWK`](../type-aliases/JWK.md)\[]>

Force a refetch; on failure keeps what is cached and rethrows.

#### Returns [#returns-151]

`Promise`\<[`JWK`](../type-aliases/JWK.md)\[]>

#### Defined in [#defined-in-1207]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:46](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L46)

***

### snapshot() [#snapshot]

> **snapshot**(): [`JwksSnapshot`](JwksSnapshot.md)

#### Returns [#returns-152]

[`JwksSnapshot`](JwksSnapshot.md)

#### Defined in [#defined-in-1208]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:47](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L47)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / JwksResolverOptions

# Interface: JwksResolverOptions [#interface-jwksresolveroptions]

## Properties [#properties-39]

### fetch? [#fetch-6]

> `optional` **fetch**: [`FetchLike`](../type-aliases/FetchLike.md)

#### Defined in [#defined-in-1209]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:21](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L21)

***

### initialKeys? [#initialkeys]

> `optional` **initialKeys**: readonly [`JWK`](../type-aliases/JWK.md)\[]

Keys to use before the first fetch and when the network never answers (embedded snapshot).

#### Defined in [#defined-in-1210]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:27](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L27)

***

### jwksUri [#jwksuri]

> **jwksUri**: `string`

#### Defined in [#defined-in-1211]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:20](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L20)

***

### minRefetchIntervalMs? [#minrefetchintervalms]

> `optional` **minRefetchIntervalMs**: `number`

Minimum time between forced refetches for unknown kids. Default 30 s.

#### Defined in [#defined-in-1212]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:25](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L25)

***

### now()? [#now-4]

> `optional` **now**: () => `number`

#### Returns [#returns-153]

`number`

#### Defined in [#defined-in-1213]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:30](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L30)

***

### onWarning()? [#onwarning-3]

> `optional` **onWarning**: (`message`, `cause`?) => `void`

#### Parameters [#parameters-116]

• **message**: `string`

• &#x2A;*cause?**: `unknown`

#### Returns [#returns-154]

`void`

#### Defined in [#defined-in-1214]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:31](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L31)

***

### timeoutMs? [#timeoutms-4]

> `optional` **timeoutMs**: `number`

Per request. Default 10 s.

#### Defined in [#defined-in-1215]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:29](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L29)

***

### ttlMs? [#ttlms-1]

> `optional` **ttlMs**: `number`

How long a fetched document is trusted without a refetch. Default 5 min.

#### Defined in [#defined-in-1216]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:23](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L23)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / JwksSnapshot

# Interface: JwksSnapshot [#interface-jwkssnapshot]

## Properties [#properties-40]

### fetchedAt [#fetchedat]

> **fetchedAt**: `null` | `number`

#### Defined in [#defined-in-1217]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:37](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L37)

***

### keys [#keys-1]

> **keys**: [`JWK`](../type-aliases/JWK.md)\[]

#### Defined in [#defined-in-1218]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:35](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L35)

***

### source [#source]

> **source**: [`JwksSource`](../type-aliases/JwksSource.md)

#### Defined in [#defined-in-1219]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:36](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L36)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / OAuthErrorBody

# Interface: OAuthErrorBody [#interface-oautherrorbody]

RFC 6749 §5.2 error object shape.

## Properties [#properties-41]

### error [#error-2]

> **error**: `string`

#### Defined in [#defined-in-1220]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:60](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L60)

***

### error\_description? [#error_description]

> `optional` **error\_description**: `string`

#### Defined in [#defined-in-1221]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:61](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L61)

***

### error\_uri? [#error_uri]

> `optional` **error\_uri**: `string`

#### Defined in [#defined-in-1222]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:62](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L62)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / OrganizationClaim

# Interface: OrganizationClaim [#interface-organizationclaim]

The `org` claim: the organization the user bound the grant to at consent, with their role in it.

## Properties [#properties-42]

### id [#id-4]

> **id**: `string`

#### Defined in [#defined-in-1223]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:47](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L47)

***

### name [#name-8]

> **name**: `string`

#### Defined in [#defined-in-1224]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:49](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L49)

***

### role [#role-3]

> **role**: [`OrganizationRole`](../type-aliases/OrganizationRole.md) | `string` & `object`

#### Defined in [#defined-in-1225]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:50](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L50)

***

### slug [#slug]

> **slug**: `string`

#### Defined in [#defined-in-1226]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:48](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L48)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / PkcePair

# Interface: PkcePair [#interface-pkcepair]

## Properties [#properties-43]

### codeChallenge [#codechallenge-1]

> **codeChallenge**: `string`

#### Defined in [#defined-in-1227]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/pkce.ts:31](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/pkce.ts#L31)

***

### codeChallengeMethod [#codechallengemethod]

> **codeChallengeMethod**: `"S256"`

#### Defined in [#defined-in-1228]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/pkce.ts:32](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/pkce.ts#L32)

***

### codeVerifier [#codeverifier-1]

> **codeVerifier**: `string`

#### Defined in [#defined-in-1229]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/pkce.ts:30](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/pkce.ts#L30)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / RefreshCoordinatorOptions

# Interface: RefreshCoordinatorOptions\<T> [#interface-refreshcoordinatoroptionst]

## Type Parameters [#type-parameters-3]

• **T** = [`TokenSet`](TokenSet.md)

## Properties [#properties-44]

### maxRemembered? [#maxremembered]

> `optional` **maxRemembered**: `number`

How many consumed tokens to remember. Default 200.

#### Defined in [#defined-in-1230]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/refresh.ts:32](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/refresh.ts#L32)

***

### now()? [#now-5]

> `optional` **now**: () => `number`

#### Returns [#returns-155]

`number`

#### Defined in [#defined-in-1231]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/refresh.ts:33](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/refresh.ts#L33)

***

### refresh() [#refresh-5]

> **refresh**: (`refreshToken`) => `Promise`\<`T`>

Performs the actual refresh\_token grant. Must throw for failures.

#### Parameters [#parameters-117]

• **refreshToken**: `string`

#### Returns [#returns-156]

`Promise`\<`T`>

#### Defined in [#defined-in-1232]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/refresh.ts:26](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/refresh.ts#L26)

***

### refreshTokenOf()? [#refreshtokenof]

> `optional` **refreshTokenOf**: (`result`) => `null` | `string`

Extract the refresh token from a result (to mark it as the successor).

#### Parameters [#parameters-118]

• **result**: `T`

#### Returns [#returns-157]

`null` | `string`

#### Defined in [#defined-in-1233]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/refresh.ts:28](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/refresh.ts#L28)

***

### successorTtlMs? [#successorttlms]

> `optional` **successorTtlMs**: `number`

How long a successor is handed out to holders of the old token. Default 60 s.

#### Defined in [#defined-in-1234]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/refresh.ts:30](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/refresh.ts#L30)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / RefreshParams

# Interface: RefreshParams [#interface-refreshparams]

## Properties [#properties-45]

### refreshToken [#refreshtoken]

> **refreshToken**: `string`

#### Defined in [#defined-in-1235]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:119](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L119)

***

### resource? [#resource-3]

> `optional` **resource**: `string`

#### Defined in [#defined-in-1236]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:122](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L122)

***

### scope? [#scope-11]

> `optional` **scope**: `string`

Narrow the scope of the new tokens (never widen).

#### Defined in [#defined-in-1237]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:121](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L121)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / RevocationParams

# Interface: RevocationParams [#interface-revocationparams]

## Properties [#properties-46]

### clientAuthentication? [#clientauthentication-4]

> `optional` **clientAuthentication**: [`ClientAuthentication`](../type-aliases/ClientAuthentication.md)

#### Defined in [#defined-in-1238]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:150](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L150)

***

### clientId [#clientid-9]

> **clientId**: `string`

#### Defined in [#defined-in-1239]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:149](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L149)

***

### fetch? [#fetch-7]

> `optional` **fetch**: [`FetchLike`](../type-aliases/FetchLike.md)

#### Defined in [#defined-in-1240]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:153](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L153)

***

### revocationEndpoint [#revocationendpoint]

> **revocationEndpoint**: `string`

#### Defined in [#defined-in-1241]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:148](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L148)

***

### timeoutMs? [#timeoutms-5]

> `optional` **timeoutMs**: `number`

#### Defined in [#defined-in-1242]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:154](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L154)

***

### token [#token-2]

> **token**: `string`

#### Defined in [#defined-in-1243]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:151](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L151)

***

### tokenTypeHint? [#tokentypehint-1]

> `optional` **tokenTypeHint**: `"access_token"` | `"refresh_token"`

#### Defined in [#defined-in-1244]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:152](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L152)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / Session

# Interface: Session [#interface-session]

## Properties [#properties-47]

### expiresAt [#expiresat-3]

> **expiresAt**: `number`

Mirrors `tokens.expiresAt`.

#### Defined in [#defined-in-1245]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:127](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L127)

***

### issuedAt [#issuedat-3]

> **issuedAt**: `number`

Mirrors `tokens.issuedAt`.

#### Defined in [#defined-in-1246]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:129](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L129)

***

### status [#status-6]

> **status**: [`SessionStatus`](../type-aliases/SessionStatus.md)

#### Defined in [#defined-in-1247]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:123](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L123)

***

### tokens [#tokens-1]

> **tokens**: [`TokenSet`](TokenSet.md)

#### Defined in [#defined-in-1248]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:125](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L125)

***

### user [#user-5]

> **user**: [`AuthUser`](AuthUser.md)

#### Defined in [#defined-in-1249]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:124](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L124)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / SessionGracePolicy

# Interface: SessionGracePolicy [#interface-sessiongracepolicy]

Session grace (plan §4 M4 "cheap first").

The issuer must not be a chokepoint: when the access token has expired and
a refresh cannot be completed because the issuer is unreachable, the app
keeps treating the user as signed in for a bounded time. Two bounds, both
absolute:

* `graceMs` after the access token expired (default 24 h);
* `maxSessionMs` after the tokens were last issued (default 7 days),
  whichever comes first.

Grace never applies to a definitive refusal (`invalid_grant`): a revoked
grant signs the user out at once.

## Properties [#properties-48]

### graceMs [#gracems]

> **graceMs**: `number`

How long past `expiresAt` a session stays usable while the issuer is unreachable.

#### Defined in [#defined-in-1250]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/grace.ts:19](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/grace.ts#L19)

***

### maxSessionMs [#maxsessionms]

> **maxSessionMs**: `number`

Hard cap measured from `issuedAt`; grace never extends past it.

#### Defined in [#defined-in-1251]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/grace.ts:21](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/grace.ts#L21)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / SignInOptions

# Interface: SignInOptions [#interface-signinoptions]

## Properties [#properties-49]

### extraParams? [#extraparams-1]

> `optional` **extraParams**: `Record`\<`string`, `string`>

#### Defined in [#defined-in-1252]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:78](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L78)

***

### loginHint? [#loginhint-4]

> `optional` **loginHint**: `string`

#### Defined in [#defined-in-1253]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:77](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L77)

***

### prompt? [#prompt-4]

> `optional` **prompt**: `"none"` | `"login"` | `"consent"` | `"select_account"`

#### Defined in [#defined-in-1254]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:76](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L76)

***

### redirectUri? [#redirecturi-5]

> `optional` **redirectUri**: `string`

Override the registered redirect URI for this sign-in.

#### Defined in [#defined-in-1255]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:80](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L80)

***

### returnTo? [#returnto-6]

> `optional` **returnTo**: `string`

Same-origin path (or any string) handed back by `handleCallback`.

#### Defined in [#defined-in-1256]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:74](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L74)

***

### scope? [#scope-12]

> `optional` **scope**: `string` | readonly `string`\[]

#### Defined in [#defined-in-1257]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:75](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L75)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / SignOutOptions

# Interface: SignOutOptions [#interface-signoutoptions]

## Properties [#properties-50]

### postLogoutRedirectUri? [#postlogoutredirecturi-3]

> `optional` **postLogoutRedirectUri**: `string`

#### Defined in [#defined-in-1258]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:91](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L91)

***

### redirect? [#redirect]

> `optional` **redirect**: `boolean`

Navigate to the issuer's end-session page (needs an ID token; ends the issuer session, confirm page). Default false.

#### Defined in [#defined-in-1259]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:90](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L90)

***

### revoke? [#revoke]

> `optional` **revoke**: `boolean`

Also revoke the refresh token at the issuer (best effort). The issuer
revokes the whole grant with it, which disconnects the app for this user
on every device, the same as "Disconnect" under Connected apps. Default
false: signing out of this app instance only.

#### Defined in [#defined-in-1260]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:98](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L98)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / TokenEndpointClient

# Interface: TokenEndpointClient [#interface-tokenendpointclient]

## Properties [#properties-51]

### clientAuthentication? [#clientauthentication-5]

> `optional` **clientAuthentication**: [`ClientAuthentication`](../type-aliases/ClientAuthentication.md)

Default `{ method: 'none' }` (public client).

#### Defined in [#defined-in-1261]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:19](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L19)

***

### clientId [#clientid-10]

> **clientId**: `string`

#### Defined in [#defined-in-1262]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:17](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L17)

***

### fetch? [#fetch-8]

> `optional` **fetch**: [`FetchLike`](../type-aliases/FetchLike.md)

#### Defined in [#defined-in-1263]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:20](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L20)

***

### signal? [#signal-2]

> `optional` **signal**: `AbortSignal`

#### Defined in [#defined-in-1264]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:23](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L23)

***

### timeoutMs? [#timeoutms-6]

> `optional` **timeoutMs**: `number`

Per request. Default 15 s.

#### Defined in [#defined-in-1265]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:22](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L22)

***

### tokenEndpoint [#tokenendpoint]

> **tokenEndpoint**: `string`

#### Defined in [#defined-in-1266]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:16](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L16)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / TokenResponse

# Interface: TokenResponse [#interface-tokenresponse]

Raw token endpoint answer (RFC 6749 §5.1).

## Indexable [#indexable-4]

\[`key`: `string`]: `unknown`

## Properties [#properties-52]

### access\_token [#access_token]

> **access\_token**: `string`

#### Defined in [#defined-in-1267]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:34](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L34)

***

### expires\_in? [#expires_in-1]

> `optional` **expires\_in**: `number`

#### Defined in [#defined-in-1268]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:36](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L36)

***

### id\_token? [#id_token]

> `optional` **id\_token**: `string`

#### Defined in [#defined-in-1269]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:38](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L38)

***

### refresh\_token? [#refresh_token]

> `optional` **refresh\_token**: `string`

#### Defined in [#defined-in-1270]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:37](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L37)

***

### scope? [#scope-13]

> `optional` **scope**: `string`

#### Defined in [#defined-in-1271]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:39](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L39)

***

### token\_type [#token_type-1]

> **token\_type**: `string`

#### Defined in [#defined-in-1272]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:35](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L35)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / TokenSet

# Interface: TokenSet [#interface-tokenset]

Normalized tokens with absolute times (epoch milliseconds).

## Properties [#properties-53]

### accessToken [#accesstoken-1]

> **accessToken**: `string`

#### Defined in [#defined-in-1273]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:101](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L101)

***

### claims [#claims-1]

> **claims**: `null` | [`IdTokenClaims`](IdTokenClaims.md)

Verified ID token claims, when an ID token was issued and verified.

#### Defined in [#defined-in-1274]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:111](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L111)

***

### expiresAt [#expiresat-4]

> **expiresAt**: `number`

When the access token stops being valid.

#### Defined in [#defined-in-1275]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:107](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L107)

***

### idToken [#idtoken-2]

> **idToken**: `null` | `string`

#### Defined in [#defined-in-1276]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:105](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L105)

***

### issuedAt [#issuedat-4]

> **issuedAt**: `number`

When this set was issued (a refresh yields a new set with a new `issuedAt`).

#### Defined in [#defined-in-1277]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:109](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L109)

***

### refreshToken [#refreshtoken-1]

> **refreshToken**: `null` | `string`

#### Defined in [#defined-in-1278]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:104](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L104)

***

### scope [#scope-14]

> **scope**: `null` | `string`

#### Defined in [#defined-in-1279]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:103](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L103)

***

### tokenType [#tokentype]

> **tokenType**: `string`

#### Defined in [#defined-in-1280]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:102](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L102)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / UserInfoParams

# Interface: UserInfoParams [#interface-userinfoparams]

## Properties [#properties-54]

### accessToken [#accesstoken-2]

> **accessToken**: `string`

#### Defined in [#defined-in-1281]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:216](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L216)

***

### fetch? [#fetch-9]

> `optional` **fetch**: [`FetchLike`](../type-aliases/FetchLike.md)

#### Defined in [#defined-in-1282]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:217](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L217)

***

### timeoutMs? [#timeoutms-7]

> `optional` **timeoutMs**: `number`

#### Defined in [#defined-in-1283]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:218](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L218)

***

### userinfoEndpoint [#userinfoendpoint]

> **userinfoEndpoint**: `string`

#### Defined in [#defined-in-1284]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/token.ts:215](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/token.ts#L215)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / VerifyIdTokenOptions

# Interface: VerifyIdTokenOptions [#interface-verifyidtokenoptions]

## Properties [#properties-55]

### clientId [#clientid-11]

> **clientId**: `string`

#### Defined in [#defined-in-1285]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/verify.ts:17](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/verify.ts#L17)

***

### clockToleranceSeconds? [#clocktoleranceseconds-1]

> `optional` **clockToleranceSeconds**: `number`

Seconds of clock skew to tolerate. Default 60.

#### Defined in [#defined-in-1286]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/verify.ts:22](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/verify.ts#L22)

***

### currentTimeSeconds? [#currenttimeseconds]

> `optional` **currentTimeSeconds**: `number`

Epoch seconds "now" (tests).

#### Defined in [#defined-in-1287]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/verify.ts:26](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/verify.ts#L26)

***

### issuer [#issuer-5]

> **issuer**: `string`

#### Defined in [#defined-in-1288]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/verify.ts:16](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/verify.ts#L16)

***

### maxAuthAgeSeconds? [#maxauthageseconds]

> `optional` **maxAuthAgeSeconds**: `number`

Reject tokens whose `auth_time` is older than this many seconds.

#### Defined in [#defined-in-1289]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/verify.ts:24](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/verify.ts#L24)

***

### nonce? [#nonce-4]

> `optional` **nonce**: `string`

The nonce sent in the authorization request. Required for tokens from the code flow; omit for refresh-issued tokens.

#### Defined in [#defined-in-1290]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/verify.ts:20](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/verify.ts#L20)

***

### resolver [#resolver]

> **resolver**: [`JwksResolver`](JwksResolver.md)

#### Defined in [#defined-in-1291]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/verify.ts:18](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/verify.ts#L18)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / AuthErrorCode

# Type Alias: AuthErrorCode [#type-alias-autherrorcode]

> **AuthErrorCode**: `"configuration"` | `"discovery_failed"` | `"network_error"` | `"invalid_response"` | `"oauth_error"` | `"invalid_state"` | `"invalid_id_token"` | `"jwks_unavailable"` | `"refresh_token_consumed"` | `"signed_out"` | `"session_expired"` | `"no_transaction"` | `"invalid_callback"` | `"device_flow_expired"` | `"access_denied"` | `"unsupported"`

Error model. Every failure the SDK raises is an [AuthError](../classes/AuthError.md) with a
stable `code`; protocol-level refusals from the issuer are an
[OAuthError](../classes/OAuthError.md) that also carries the RFC 6749 `error` string.

Two questions callers ask are answered by helpers here:

* [isSignedOutError](../functions/isSignedOutError.md): did the issuer (or the SDK) decide the user is
  no longer signed in? Then clear the local session and show the sign-in
  button. Retrying never helps.
* [isTransientError](../functions/isTransientError.md): did the request simply not get through? Then
  keep the current session under the grace policy and try again later.

## Defined in [#defined-in-1292]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/errors.ts:14](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/errors.ts#L14)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / ClientAuthentication

# Type Alias: ClientAuthentication [#type-alias-clientauthentication]

> **ClientAuthentication**: `object` | `object` | `object`

How a client authenticates at the token, revocation and introspection endpoints.

## Defined in [#defined-in-1293]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:133](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L133)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / FetchLike

# Type Alias: FetchLike() [#type-alias-fetchlike]

> **FetchLike**: (`input`, `init`?) => `Promise`\<`Response`>

## Parameters [#parameters-119]

• **input**: `string` | `URL`

• &#x2A;*init?**: `RequestInit`

## Returns [#returns-158]

`Promise`\<`Response`>

## Defined in [#defined-in-1294]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/util.ts:8](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/util.ts#L8)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / GraceVerdict

# Type Alias: GraceVerdict [#type-alias-graceverdict]

> **GraceVerdict**: `"active"` | `"grace"` | `"expired"`

## Defined in [#defined-in-1295]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/grace.ts:32](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/grace.ts#L32)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / JWK

# Type Alias: JWK [#type-alias-jwk]

> **JWK**: `object`

JSON Web Key ([JWK](https://www.rfc-editor.org/info/rfc7517/)). "RSA", "EC", "OKP", "AKP",
and "oct" key types are supported.

> Note: This is declared as a type alias rather than an interface so that it satisfies the implicit index
> signature of the `JsonWebKey` types shipped by `@types/node` and `lib.dom`. It spells out the
> JWKParameters members rather than intersecting them so that every JWK member is documented
> in one place.

## Type declaration [#type-declaration]

### alg? [#alg]

> `optional` **alg**: `JWSAlgorithm` | `JWEKeyManagementAlgorithm` | `JWEContentEncryptionAlgorithm`

JWK "alg" (Algorithm) Parameter

### crv? [#crv]

> `optional` **crv**: `string`

EC curve or OKP key pair subtype.

### d? [#d-1]

> `optional` **d**: `string`

Private RSA exponent, EC key, or OKP key.

### dp? [#dp]

> `optional` **dp**: `string`

RSA first factor CRT exponent.

### dq? [#dq]

> `optional` **dq**: `string`

RSA second factor CRT exponent.

### e? [#e]

> `optional` **e**: `string`

RSA public exponent.

### ext? [#ext]

> `optional` **ext**: `boolean`

Whether the key may be exported.

### k? [#k-1]

> `optional` **k**: `string`

Symmetric key value.

### key\_ops? [#key_ops]

> `optional` **key\_ops**: `string`\[]

Permitted key operations.

### kid? [#kid]

> `optional` **kid**: `string`

JWK "kid" (Key ID) Parameter

### kty? [#kty]

> `optional` **kty**: `JWKKeyType`

JWK "kty" (Key Type) Parameter

### n? [#n]

> `optional` **n**: `string`

RSA modulus.

### oth? [#oth]

> `optional` **oth**: `object`\[]

Additional RSA prime factors.

### p? [#p]

> `optional` **p**: `string`

RSA first prime factor.

### priv? [#priv]

> `optional` **priv**: `string`

AKP JWK "priv" (Private key) Parameter

### pub? [#pub]

> `optional` **pub**: `string`

AKP JWK "pub" (Public Key) Parameter

### q? [#q]

> `optional` **q**: `string`

RSA second prime factor.

### qi? [#qi]

> `optional` **qi**: `string`

RSA first CRT coefficient.

### use? [#use]

> `optional` **use**: `"sig"` | `"enc"` | `string` & `object`

JWK "use" (Public Key Use) Parameter

### x? [#x-1]

> `optional` **x**: `string`

EC public key X coordinate or OKP public key.

### x5c? [#x5c]

> `optional` **x5c**: `string`\[]

X.509 certificate chain.

### x5t? [#x5t]

> `optional` **x5t**: `string`

X.509 certificate SHA-1 thumbprint.

### x5t#S256? [#x5ts256]

> `optional` **x5t#S256**: `string`

X.509 certificate SHA-256 thumbprint.

### x5u? [#x5u]

> `optional` **x5u**: `string`

X.509 certificate URL.

### y? [#y-1]

> `optional` **y**: `string`

EC public key Y coordinate.

## Defined in [#defined-in-1296]

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node\_modules/jose/dist/types/types.d.ts:175

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / JwksSource

# Type Alias: JwksSource [#type-alias-jwkssource]

> **JwksSource**: `"network"` | `"stale"` | `"initial"` | `"none"`

## Defined in [#defined-in-1297]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/jwks.ts:17](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/jwks.ts#L17)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / OrganizationRole

# Type Alias: OrganizationRole [#type-alias-organizationrole]

> **OrganizationRole**: `"OWNER"` | `"ADMIN"` | `"MEMBER"`

## Defined in [#defined-in-1298]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:43](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L43)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / SessionListener

# Type Alias: SessionListener() [#type-alias-sessionlistener]

> **SessionListener**: (`session`) => `void`

## Parameters [#parameters-120]

• **session**: [`Session`](../interfaces/Session.md) | `null`

## Returns [#returns-159]

`void`

## Defined in [#defined-in-1299]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/client.ts:101](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/client.ts#L101)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / SessionStatus

# Type Alias: SessionStatus [#type-alias-sessionstatus]

> **SessionStatus**: `"active"` | `"grace"`

`active`: the access token is valid.
`grace`: the access token expired and a refresh could not be completed because the
issuer could not be reached; the session is still treated as signed in under the
[SessionGracePolicy](../interfaces/SessionGracePolicy.md) until the cap.

## Defined in [#defined-in-1300]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/types.ts:120](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/types.ts#L120)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / StorageKind

# Type Alias: StorageKind [#type-alias-storagekind]

> **StorageKind**: `"memory"` | `"session"` | `"local"`

## Defined in [#defined-in-1301]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/storage.ts:20](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/storage.ts#L20)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / DEFAULT\_GRACE\_POLICY

# Variable: DEFAULT\_GRACE\_POLICY [#variable-default_grace_policy]

> `const` **DEFAULT\_GRACE\_POLICY**: [`SessionGracePolicy`](../interfaces/SessionGracePolicy.md)

## Defined in [#defined-in-1302]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/grace.ts:24](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/grace.ts#L24)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / DEFAULT\_ISSUER

# Variable: DEFAULT\_ISSUER [#variable-default_issuer]

> `const` **DEFAULT\_ISSUER**: `"https://auth.alternatefutures.ai"` = `'https://auth.alternatefutures.ai'`

The production issuer identifier.

## Defined in [#defined-in-1303]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:30](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L30)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / DEFAULT\_SCOPES

# Variable: DEFAULT\_SCOPES [#variable-default_scopes]

> `const` **DEFAULT\_SCOPES**: readonly \[`"openid"`, `"profile"`, `"email"`]

What a sign-in asks for when the app does not say.

## Defined in [#defined-in-1304]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:36](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L36)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / DEVICE\_CODE\_GRANT

# Variable: DEVICE\_CODE\_GRANT [#variable-device_code_grant]

> `const` **DEVICE\_CODE\_GRANT**: `"urn:ietf:params:oauth:grant-type:device_code"` = `'urn:ietf:params:oauth:grant-type:device_code'`

## Defined in [#defined-in-1305]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/device.ts:15](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/device.ts#L15)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / EMBEDDED\_JWKS

# Variable: EMBEDDED\_JWKS [#variable-embedded_jwks]

> `const` **EMBEDDED\_JWKS**: `object`

## Defined in [#defined-in-1306]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/embedded-keys.ts:12](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/embedded-keys.ts#L12)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / ID\_TOKEN\_ALGORITHMS

# Variable: ID\_TOKEN\_ALGORITHMS [#variable-id_token_algorithms]

> `const` **ID\_TOKEN\_ALGORITHMS**: readonly \[`"EdDSA"`, `"ES256"`]

ID token algorithms the issuer signs with; nothing else is ever accepted.

## Defined in [#defined-in-1307]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:39](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L39)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / ISSUER\_PATHS

# Variable: ISSUER\_PATHS [#variable-issuer_paths]

> `const` **ISSUER\_PATHS**: `object`

Paths of the issuer, relative to the issuer identifier.

## Type declaration [#type-declaration-1]

### authorization [#authorization-1]

> `readonly` **authorization**: `"/oidc/auth"` = `'/oidc/auth'`

### deviceAuthorization [#deviceauthorization]

> `readonly` **deviceAuthorization**: `"/oidc/device/auth"` = `'/oidc/device/auth'`

### discovery [#discovery]

> `readonly` **discovery**: `"/.well-known/openid-configuration"` = `'/.well-known/openid-configuration'`

### endSession [#endsession]

> `readonly` **endSession**: `"/oidc/session/end"` = `'/oidc/session/end'`

### introspection [#introspection]

> `readonly` **introspection**: `"/oidc/token/introspection"` = `'/oidc/token/introspection'`

### jwks [#jwks-1]

> `readonly` **jwks**: `"/.well-known/jwks.json"` = `'/.well-known/jwks.json'`

### revocation [#revocation]

> `readonly` **revocation**: `"/oidc/token/revocation"` = `'/oidc/token/revocation'`

### token [#token-3]

> `readonly` **token**: `"/oidc/token"` = `'/oidc/token'`

### userinfo [#userinfo-1]

> `readonly` **userinfo**: `"/oidc/me"` = `'/oidc/me'`

## Defined in [#defined-in-1308]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:17](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L17)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / NO\_GRACE\_POLICY

# Variable: NO\_GRACE\_POLICY [#variable-no_grace_policy]

> `const` **NO\_GRACE\_POLICY**: [`SessionGracePolicy`](../interfaces/SessionGracePolicy.md)

A policy with no grace at all: an expired access token is an expired session.

## Defined in [#defined-in-1309]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/grace.ts:30](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/grace.ts#L30)

***

[**@alternatefutures/ac-auth-sdk-monorepo**](../../../README.md) • **Docs**

***

[@alternatefutures/ac-auth-sdk-monorepo](../../../README.md) / [ac-auth/src](../README.md) / SUPPORTED\_SCOPES

# Variable: SUPPORTED\_SCOPES [#variable-supported_scopes]

> `const` **SUPPORTED\_SCOPES**: readonly \[`"openid"`, `"profile"`, `"email"`, `"org"`, `"wallet"`, `"offline_access"`]

Scopes the issuer understands.

## Defined in [#defined-in-1310]

[work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth/src/discovery.ts:33](https://github.com/alternatefutures/alternate-auth-sdk/blob/main/packages/ac-auth/src/discovery.ts#L33)

***
