KysoqlAPI referenceInterfaces
ClientCredentialsOptions
Generated API reference for ClientCredentialsOptions in @kysoql/auth.
@kysoql/auth / ClientCredentialsOptions
Options for the Salesforce OAuth client-credentials grant.
Extends
TokenEndpointOptions
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
clientId | readonly | string | Salesforce My Domain origin configured for client credentials. | - |
clientSecret | readonly | string | Connected App client secret used by the client-credentials grant. | - |
clientSecretTransport? | readonly | "body" | "basic" | Default: body. Salesforce also accepts HTTP Basic. | - |
loginUrl | readonly | string | Salesforce login or My Domain base URL for the token endpoint. | TokenEndpointOptions.loginUrl |
refreshTokenStore? | readonly | RefreshTokenStore | Persist a newly issued/rotated refresh token before returning the session. | TokenEndpointOptions.refreshTokenStore |
signal? | readonly | AbortSignal | Cancels this request. | TokenEndpointOptions.signal |
timeoutMs? | readonly | number | Per HTTP request. Default: 30 seconds. | TokenEndpointOptions.timeoutMs |
fetch? | readonly | (input, init?) => Promise<Response> | Native fetch by default. Primarily useful for tests and custom runtimes. | TokenEndpointOptions.fetch |