Kysoql
API referenceInterfaces

CodeCredentialsNamedUserOptions

Generated API reference for CodeCredentialsNamedUserOptions in @kysoql/auth.

@kysoql/auth / CodeCredentialsNamedUserOptions

Options for headless authorization with an explicit Salesforce username and password.

Extends

  • CodeCredentialsAuthorizationBase

Properties

PropertyModifierTypeDescriptionInherited from
usernamereadonlystringSalesforce username associated with the authorization flow.-
passwordreadonlystringSalesforce password supplied to the headless credentials flow.-
credentialsPlacement?readonly"authorization-header" | "body"Default: authorization-header. Use body when the app requires POST-body credentials.-
loginHint?readonlyundefinedNot accepted in named-user mode; use user-discovery options instead.-
customData?readonlyundefinedNot accepted in named-user mode; only user-discovery requests support custom data.-
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

ClientCredentialsOptions

Generated API reference for ClientCredentialsOptions in @kysoql/auth.

CodeCredentialsUserDiscoveryOptions

Generated API reference for CodeCredentialsUserDiscoveryOptions in @kysoql/auth.

On this page

ExtendsProperties