Kysoql
API referenceInterfaces

CodeCredentialsUserDiscoveryOptions

Generated API reference for CodeCredentialsUserDiscoveryOptions in @kysoql/auth.

@kysoql/auth / CodeCredentialsUserDiscoveryOptions

Options for headless authorization that discovers the Salesforce user from a login hint.

Extends

  • CodeCredentialsAuthorizationBase

Properties

PropertyModifierTypeDescriptionInherited from
loginHintreadonlystringHeadless user-discovery identifier passed to the Apex discovery handler.-
passwordreadonlystringSalesforce password supplied to the headless credentials flow.-
customData?readonlystringApplication-defined data forwarded to the Salesforce user-discovery handler.-
username?readonlyundefinedNot accepted in user-discovery mode; Salesforce resolves the user from loginHint.-
credentialsPlacement?readonly"body"User-discovery credentials must be sent in the POST body.-
siteUrlreadonlystringExperience Cloud site base URL, including a site path when configured.CodeCredentialsAuthorizationBase.siteUrl
clientIdreadonlystringConnected App consumer key / OAuth client ID.CodeCredentialsAuthorizationBase.clientId
redirectUrireadonlystringRedirect URI registered with the Connected App.CodeCredentialsAuthorizationBase.redirectUri
codeChallenge?readonlystringPKCE S256 challenge paired with the verifier used during code exchange.CodeCredentialsAuthorizationBase.codeChallenge
scope?readonlystring | readonly string[]OAuth scopes requested from Salesforce.CodeCredentialsAuthorizationBase.scope
state?readonlystringOpaque state value returned unchanged for request correlation.CodeCredentialsAuthorizationBase.state
uvidHint?readonlystringPlain UVID body parameter. Mutually exclusive with uvidHintToken.CodeCredentialsAuthorizationBase.uvidHint
uvidHintToken?readonlystringJWT-based access token containing a UVID, sent as the Uvid-Hint header.CodeCredentialsAuthorizationBase.uvidHintToken

CodeCredentialsNamedUserOptions

Generated API reference for CodeCredentialsNamedUserOptions in @kysoql/auth.

DeviceAuthorization

Generated API reference for DeviceAuthorization in @kysoql/auth.

On this page

ExtendsProperties