Kysoql
API referenceInterfaces

StoredRefreshTokenAuthOptions

Generated API reference for StoredRefreshTokenAuthOptions in @kysoql/auth.

@kysoql/auth / StoredRefreshTokenAuthOptions

Options for access-token management backed by a persistent refresh-token store.

Extends

Properties

PropertyModifierTypeDescriptionInherited from
loginUrlreadonlystringSalesforce login or My Domain base URL used for token refresh.-
clientIdreadonlystringConnected App consumer key / OAuth client ID.-
clientSecret?readonlystringConnected App client secret for confidential-client authentication.-
clientSecretTransport?readonly"body" | "basic"Default: body. Salesforce also accepts HTTP Basic for client secrets.-
clientAssertion?readonlyClientAssertionProviderCalled for each refresh so short-lived client assertions can be regenerated.-
refreshMode?readonly"standard" | "hybrid"Default: standard. Use hybrid only for Salesforce hybrid-app refresh tokens.-
refreshTokenStorereadonlyRefreshTokenStoreStore used to load and persist refresh tokens, including rotated tokens.-
initialRefreshToken?readonlystringUsed only when the store is initially empty. Persisted after the first successful refresh.-
signal?readonlyAbortSignalCancels this request.OAuthRequestOptions.signal
timeoutMs?readonlynumberPer HTTP request. Default: 30 seconds.OAuthRequestOptions.timeoutMs
fetch?readonly(input, init?) => Promise<Response>Native fetch by default. Primarily useful for tests and custom runtimes.OAuthRequestOptions.fetch

On this page