Kysoql
API referenceInterfaces

AuthorizationUrlOptions

Generated API reference for AuthorizationUrlOptions in @kysoql/auth.

@kysoql/auth / AuthorizationUrlOptions

Options for building a Salesforce OAuth authorization URL.

Properties

PropertyModifierTypeDescription
loginUrlreadonlystringSalesforce login or My Domain base URL used for authorization.
clientIdreadonlystringConnected App consumer key / OAuth client ID.
redirectUrireadonlystringRedirect URI registered with the Connected App.
scope?readonlystring | readonly string[]Requested OAuth scopes; arrays are serialized as a space-delimited value.
state?readonlystringOpaque state value returned unchanged by Salesforce for request correlation.
nonce?readonlystringOpenID Connect nonce used to correlate an ID token with the authorization request.
prompt?readonlystringOAuth prompt parameter forwarded to Salesforce.
loginHint?readonlystringOptional username/login hint forwarded to Salesforce.
display?readonlystringSalesforce display parameter for the authorization UI.
codeChallenge?readonlystringPKCE S256 code challenge paired with the verifier used during token exchange.

On this page