Skip to main content

Overview

useAddAccount returns an addAccount function that clears the active auth state, allowing the user to sign into a new account. Previously stored accounts are not removed — they remain in the accounts map and can be restored with useSwitchAccount. After the user completes sign-in, the new account is added to the accounts map automatically.
A maximum of 5 accounts can be stored simultaneously. canAddAccount is false when the limit is reached.

Usage Example

Returns

addAccount
function
Clears the current access token, refresh token, and user state from Redux. The existing accounts map is preserved. After calling this function, the app should display sign-in UI for the new account.
canAddAccount
boolean
true if fewer than 5 accounts are currently stored. false when the maximum is reached.

Integration Guide

For multi-account integration guidance, see Multi-Account.