Skip to main content

UseIdentityOptions

Agent Runtimes


Agent Runtimes / identity/useIdentity / UseIdentityOptions

Interface: UseIdentityOptions

Defined in: identity/useIdentity.ts:33

Options for useIdentity hook

Properties

autoHandleCallback?

optional autoHandleCallback?: boolean

Defined in: identity/useIdentity.ts:56

Auto-handle OAuth callback from URL params


baseUrl?

optional baseUrl?: string

Defined in: identity/useIdentity.ts:52

Base URL for redirect URIs (defaults to window.location.origin)


callbackPath?

optional callbackPath?: string

Defined in: identity/useIdentity.ts:54

Callback path for OAuth redirects (defaults to /oauth/callback)


providers?

optional providers?: object

Defined in: identity/useIdentity.ts:41

Provider configurations to initialize. Each provider has specific requirements:

  • GitHub: clientId required, client_secret handled server-side
  • Google: clientId required, supports pure PKCE
  • Kaggle: clientId required, standard OAuth 2.1

custom?

optional custom?: OAuthProviderConfig[]

Custom provider configurations.

github?

optional github?: object

GitHub OAuth configuration. Note: client_secret must be configured server-side.

github.clientId

clientId: string

github.redirectUri?

optional redirectUri?: string

github.scopes?

optional scopes?: string[]

google?

optional google?: object

Google OAuth configuration. Supports offline access mode.

google.clientId

clientId: string

google.redirectUri?

optional redirectUri?: string

google.scopes?

optional scopes?: string[]

kaggle?

optional kaggle?: object

Kaggle OAuth configuration.

kaggle.clientId

clientId: string

kaggle.redirectUri?

optional redirectUri?: string

kaggle.scopes?

optional scopes?: string[]