KysoqlAPI referenceInterfaces
SamlBearerOptions
Generated API reference for SamlBearerOptions in @kysoql/auth.
@kysoql/auth / SamlBearerOptions
Options for the Salesforce SAML bearer token grant.
Extends
TokenEndpointOptions
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
assertion | readonly | string | Base64-encoded SAML bearer assertion submitted to Salesforce. | - |
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 |