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
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
loginUrl | readonly | string | Salesforce login or My Domain base URL used for token refresh. | - |
clientId | readonly | string | Connected App consumer key / OAuth client ID. | - |
clientSecret? | readonly | string | Connected App client secret for confidential-client authentication. | - |
clientSecretTransport? | readonly | "body" | "basic" | Default: body. Salesforce also accepts HTTP Basic for client secrets. | - |
clientAssertion? | readonly | ClientAssertionProvider | Called 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. | - |
refreshTokenStore | readonly | RefreshTokenStore | Store used to load and persist refresh tokens, including rotated tokens. | - |
initialRefreshToken? | readonly | string | Used only when the store is initially empty. Persisted after the first successful refresh. | - |
signal? | readonly | AbortSignal | Cancels this request. | OAuthRequestOptions.signal |
timeoutMs? | readonly | number | Per 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 |