# RefreshTokenOptions (/docs/rest/api/interfaces/RefreshTokenOptions)



[@kysoql/rest](/docs/rest/api) / RefreshTokenOptions

Options for the Salesforce refresh-token grant in the REST package.

## Extends [#extends]

* [`HttpOptions`](/docs/rest/api/interfaces/HttpOptions)

## Properties [#properties]

| Property                                             | Modifier   | Type                                         | Description                                                                           | Inherited from                                                                                                                     |
| ---------------------------------------------------- | ---------- | -------------------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| <a id="api-property-loginurl" /> `loginUrl`          | `readonly` | `string`                                     | Salesforce login or My Domain base URL.                                               | -                                                                                                                                  |
| <a id="api-property-clientid" /> `clientId`          | `readonly` | `string`                                     | Connected App consumer key / OAuth client ID.                                         | -                                                                                                                                  |
| <a id="api-property-clientsecret" /> `clientSecret?` | `readonly` | `string`                                     | Required when the application's OAuth policy requires a secret for refresh.           | -                                                                                                                                  |
| <a id="api-property-refreshtoken" /> `refreshToken`  | `readonly` | `string`                                     | Refresh token to exchange for a new access token.                                     | -                                                                                                                                  |
| <a id="api-property-fetch" /> `fetch?`               | `readonly` | (`input`, `init?`) => `Promise`\<`Response`> | Native fetch by default. An injected implementation must honour signal and redirect.  | [`HttpOptions`](/docs/rest/api/interfaces/HttpOptions).[`fetch`](/docs/rest/api/interfaces/HttpOptions#api-property-fetch)         |
| <a id="api-property-signal" /> `signal?`             | `readonly` | `AbortSignal`                                | Combines with the client's signal; cancelling one operation does not cancel others.   | [`HttpOptions`](/docs/rest/api/interfaces/HttpOptions).[`signal`](/docs/rest/api/interfaces/HttpOptions#api-property-signal)       |
| <a id="api-property-timeoutms" /> `timeoutMs?`       | `readonly` | `number`                                     | Per HTTP request, including token acquisition and response body. Default: 30 seconds. | [`HttpOptions`](/docs/rest/api/interfaces/HttpOptions).[`timeoutMs`](/docs/rest/api/interfaces/HttpOptions#api-property-timeoutms) |