Skip to main content

Interface: StartOAuthOpts

Defined in: Extensions/ExtensionApiDtos.ts:910

Properties

audience?

optional audience?: string

Defined in: Extensions/ExtensionApiDtos.ts:928

Optional, e.g. for Auth0.


authorizeUrl

authorizeUrl: string

Defined in: Extensions/ExtensionApiDtos.ts:913


clientId

clientId: string

Defined in: Extensions/ExtensionApiDtos.ts:915


clientSecret?

optional clientSecret?: string

Defined in: Extensions/ExtensionApiDtos.ts:921

If present, the host adds it to the token-exchange request. Public clients should omit it and rely on PKCE only. The secret never crosses back into the worker.


extraAuthorizeParams?

optional extraAuthorizeParams?: Record<string, string>

Defined in: Extensions/ExtensionApiDtos.ts:929


extraTokenParams?

optional extraTokenParams?: Record<string, string>

Defined in: Extensions/ExtensionApiDtos.ts:930


pkce?

optional pkce?: boolean

Defined in: Extensions/ExtensionApiDtos.ts:924

Default true.


prompt?

optional prompt?: "none" | "login" | "consent" | "select_account"

Defined in: Extensions/ExtensionApiDtos.ts:933

Force re-consent even if the user is signed in to the provider.


providerId

providerId: string

Defined in: Extensions/ExtensionApiDtos.ts:912

Namespaced 'ext..'.


redirectPath?

optional redirectPath?: string

Defined in: Extensions/ExtensionApiDtos.ts:926

Redirect URI path under ext-ui:///. Default 'oauth/callback'.


scopes

scopes: string[]

Defined in: Extensions/ExtensionApiDtos.ts:922


tokenUrl

tokenUrl: string

Defined in: Extensions/ExtensionApiDtos.ts:914


windowTitle?

optional windowTitle?: LocalizedString

Defined in: Extensions/ExtensionApiDtos.ts:931