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



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

Options for the Salesforce OAuth client-credentials grant.

## Extends [#extends]

* `TokenEndpointOptions`

## Properties [#properties]

| Property                                                               | Modifier   | Type                                                               | Description                                                                | Inherited from                           |
| ---------------------------------------------------------------------- | ---------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------- | ---------------------------------------- |
| <a id="api-property-clientid" /> `clientId`                            | `readonly` | `string`                                                           | Salesforce My Domain origin configured for client credentials.             | -                                        |
| <a id="api-property-clientsecret" /> `clientSecret`                    | `readonly` | `string`                                                           | Connected App client secret used by the client-credentials grant.          | -                                        |
| <a id="api-property-clientsecrettransport" /> `clientSecretTransport?` | `readonly` | `"body"` \| `"basic"`                                              | Default: body. Salesforce also accepts HTTP Basic.                         | -                                        |
| <a id="api-property-loginurl" /> `loginUrl`                            | `readonly` | `string`                                                           | Salesforce login or My Domain base URL for the token endpoint.             | `TokenEndpointOptions.loginUrl`          |
| <a id="api-property-refreshtokenstore" /> `refreshTokenStore?`         | `readonly` | [`RefreshTokenStore`](/docs/auth/api/interfaces/RefreshTokenStore) | Persist a newly issued/rotated refresh token before returning the session. | `TokenEndpointOptions.refreshTokenStore` |
| <a id="api-property-signal" /> `signal?`                               | `readonly` | `AbortSignal`                                                      | Cancels this request.                                                      | `TokenEndpointOptions.signal`            |
| <a id="api-property-timeoutms" /> `timeoutMs?`                         | `readonly` | `number`                                                           | Per HTTP request. Default: 30 seconds.                                     | `TokenEndpointOptions.timeoutMs`         |
| <a id="api-property-fetch" /> `fetch?`                                 | `readonly` | (`input`, `init?`) => `Promise`\<`Response`>                       | Native fetch by default. Primarily useful for tests and custom runtimes.   | `TokenEndpointOptions.fetch`             |