Skip to content

Graphorin API reference v0.7.0


Graphorin API reference / @graphorin/security / / AuthorizeCodeOptions

Interface: AuthorizeCodeOptions

Defined in: packages/security/src/oauth/types.ts:186

Options accepted by OAuthClient.authorizeCode(...).

Stable

Properties

PropertyModifierTypeDescriptionDefined in
callbackTimeoutMs?readonlynumberMaximum time spent waiting for the callback. Defaults to 5 min.packages/security/src/oauth/types.ts:206
openAuthorizationUrl?readonly(url, signal?) => void | Promise<void>Function to render the authorization URL to the user. Defaults to openInBrowser(url) plus a console fallback. Consumers can plug in their own UI.packages/security/src/oauth/types.ts:199
portRange?readonlyreadonly [number, number]Override the localhost port range. Inclusive on both ends. Defaults to [49152, 65535].packages/security/src/oauth/types.ts:204
redirectUri?readonlystringPre-existing redirect URI. When omitted the client will spin up a localhost callback server on a random port in 49152-65535 and use http://127.0.0.1:<port>/callback.packages/security/src/oauth/types.ts:193
scope?readonlystring-packages/security/src/oauth/types.ts:187
signal?readonlyAbortSignalCancellation. Aborts the callback server, browser open, and exchange.packages/security/src/oauth/types.ts:208