KysoqlAPI referenceInterfaces
AuthorizationCodeOptions
Generated API reference for AuthorizationCodeOptions in @kysoql/auth.
@kysoql/auth / AuthorizationCodeOptions
Options for exchanging a Salesforce authorization code for tokens.
Extends
TokenEndpointOptions.OAuthClientAuthentication
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
clientId | readonly | string | Connected App consumer key / OAuth client ID. | - |
code | readonly | string | Authorization code returned by Salesforce. | - |
redirectUri | readonly | string | Redirect URI used for the original authorization request. | - |
codeVerifier? | readonly | string | PKCE verifier corresponding to the authorization request challenge. | - |
authRequestType? | readonly | string | Headless Identity code exchanges can require an Auth-Request-Type header, for example "guest". Omit for ordinary web-server exchanges. | - |
uvidHint? | readonly | string | Headless guest code exchanges require the raw UVID or UVID-bearing token in the Uvid-Hint header. Do not add the authorization-request prefix here. | - |
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 |
clientSecret? | readonly | string | Use only from a confidential client that can keep this secret. | OAuthClientAuthentication.clientSecret |
clientAssertion? | readonly | string | JWT client assertion accepted by Salesforce instead of clientSecret. | OAuthClientAuthentication.clientAssertion |
clientSecretTransport? | readonly | "body" | "basic" | Default: body. Salesforce also accepts HTTP Basic for client secrets. | OAuthClientAuthentication.clientSecretTransport |