KysoqlAPI referenceInterfaces
StoredRefreshTokenAuth
Generated API reference for StoredRefreshTokenAuth in @kysoql/auth.
@kysoql/auth / StoredRefreshTokenAuth
Access-token manager that refreshes and persists rotated Salesforce refresh tokens.
Methods
getSession()
getSession(): Promise<SalesforceOAuthSession>;Returns the cached session, refreshing from the stored refresh token when needed.
Returns
Promise<SalesforceOAuthSession>
refresh()
refresh(): Promise<SalesforceOAuthSession>;Forces a token refresh and persists any rotated refresh token.
Returns
Promise<SalesforceOAuthSession>
clear()
clear(): Promise<void>;Clears cached session state and deletes the persisted refresh token.
Returns
Promise<void>
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
accessTokenProvider | readonly | AccessTokenProvider | Provider suitable for REST clients that can request a forced refresh after authentication failure. |