# StoredRefreshTokenAuthOptions (/docs/auth/api/interfaces/StoredRefreshTokenAuthOptions)



[@kysoql/auth](/docs/auth/api) / StoredRefreshTokenAuthOptions

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

## Extends [#extends]

* [`OAuthRequestOptions`](/docs/auth/api/interfaces/OAuthRequestOptions)

## Properties [#properties]

| Property                                                               | Modifier   | Type                                                                             | Description                                                                                | Inherited from                                                                                                                                             |
| ---------------------------------------------------------------------- | ---------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a id="api-property-loginurl" /> `loginUrl`                            | `readonly` | `string`                                                                         | Salesforce login or My Domain base URL used for token refresh.                             | -                                                                                                                                                          |
| <a id="api-property-clientid" /> `clientId`                            | `readonly` | `string`                                                                         | Connected App consumer key / OAuth client ID.                                              | -                                                                                                                                                          |
| <a id="api-property-clientsecret" /> `clientSecret?`                   | `readonly` | `string`                                                                         | Connected App client secret for confidential-client authentication.                        | -                                                                                                                                                          |
| <a id="api-property-clientsecrettransport" /> `clientSecretTransport?` | `readonly` | `"body"` \| `"basic"`                                                            | Default: body. Salesforce also accepts HTTP Basic for client secrets.                      | -                                                                                                                                                          |
| <a id="api-property-clientassertion" /> `clientAssertion?`             | `readonly` | [`ClientAssertionProvider`](/docs/auth/api/type-aliases/ClientAssertionProvider) | Called for each refresh so short-lived client assertions can be regenerated.               | -                                                                                                                                                          |
| <a id="api-property-refreshmode" /> `refreshMode?`                     | `readonly` | `"standard"` \| `"hybrid"`                                                       | Default: standard. Use hybrid only for Salesforce hybrid-app refresh tokens.               | -                                                                                                                                                          |
| <a id="api-property-refreshtokenstore" /> `refreshTokenStore`          | `readonly` | [`RefreshTokenStore`](/docs/auth/api/interfaces/RefreshTokenStore)               | Store used to load and persist refresh tokens, including rotated tokens.                   | -                                                                                                                                                          |
| <a id="api-property-initialrefreshtoken" /> `initialRefreshToken?`     | `readonly` | `string`                                                                         | Used only when the store is initially empty. Persisted after the first successful refresh. | -                                                                                                                                                          |
| <a id="api-property-signal" /> `signal?`                               | `readonly` | `AbortSignal`                                                                    | Cancels this request.                                                                      | [`OAuthRequestOptions`](/docs/auth/api/interfaces/OAuthRequestOptions).[`signal`](/docs/auth/api/interfaces/OAuthRequestOptions#api-property-signal)       |
| <a id="api-property-timeoutms" /> `timeoutMs?`                         | `readonly` | `number`                                                                         | Per HTTP request. Default: 30 seconds.                                                     | [`OAuthRequestOptions`](/docs/auth/api/interfaces/OAuthRequestOptions).[`timeoutMs`](/docs/auth/api/interfaces/OAuthRequestOptions#api-property-timeoutms) |
| <a id="api-property-fetch" /> `fetch?`                                 | `readonly` | (`input`, `init?`) => `Promise`\<`Response`>                                     | Native fetch by default. Primarily useful for tests and custom runtimes.                   | [`OAuthRequestOptions`](/docs/auth/api/interfaces/OAuthRequestOptions).[`fetch`](/docs/auth/api/interfaces/OAuthRequestOptions#api-property-fetch)         |