KysoqlAPI referenceInterfaces
FirstPartyAuthorizationChallengeOptions
Generated API reference for FirstPartyAuthorizationChallengeOptions in @kysoql/auth.
@kysoql/auth / FirstPartyAuthorizationChallengeOptions
Options for requesting a first-party Salesforce authorization challenge.
Extends
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
siteUrl | readonly | string | Experience Cloud site base URL, including a site path when configured. | - |
parameters | readonly | Readonly<Record<string, FirstPartyAuthorizationValue>> | Flow-specific body parameters documented by Salesforce. | - |
bodyFormat? | readonly | "form" | "json" | Default: form. Use json for flows such as headless registration. | - |
uvidHintToken? | readonly | string | Optional UVID JWT access token used to carry guest-session context. | - |
accessToken? | readonly | string | Optional bearer token for flows whose Experience Cloud policy requires one. | - |
signal? | readonly | AbortSignal | Cancels this request. | OAuthRequestOptions.signal |
timeoutMs? | readonly | number | Per HTTP request. Default: 30 seconds. | OAuthRequestOptions.timeoutMs |
fetch? | readonly | (input, init?) => Promise<Response> | Native fetch by default. Primarily useful for tests and custom runtimes. | OAuthRequestOptions.fetch |