useAuth
This page's documentation only applies to Chord's Next.js starter prior to the release of the React SDK. The Next.js starter now uses the React SDK and does not use the methods documented on this page. Check out the React SDK Reference for complete documentation, and the React SDK Migration Guide for details on how to upgrade.
The useAuth hook returns information about the current authentication session, and functions for logging in and logging out. Chord supports passwordless authentication with Magic.
The useAuth hook returns an object with these properties:
Property | Description |
isLoggedIn | A boolean indicating whether the user is currently logged in. |
isFetching | A boolean indicating whether the user's authentication status is currently being fetched. |
token | A string representing the user's authentication token. This token is automatically appended to Chord OMS API requests when the user has an active session. |
getToken | A function that retrieves an authentication token for the current user session. |
handleCallback | A function that completes the login process, when the user is redirected back to the site after clicking a link in their email. |
login | A function that should be called when a user submits a login form. |
logout | A function that terminates the user's current session. |
The getToken function retrieves an authentication token for the current user session, and adds it the Redux store. While you are unlikely to need the token directly, since the SDK automatically appends it to relevant Chord API requests, you can use this function to check whether the user's session is still active. If the user's session has expired, getToken will throw an error.
You may choose to call getToken on page load or when a user visits a protected route (like an account page) to check that their session has not expired since the last time you checked.
Arguments:
None.
Returns:
Promise<void>: A Promise that resolves when the token has been added to the Redux store.
Example:
The handleCallback function completes the login process, when the user is redirected back to the site after clicking a link in their email. The SDK calls this function automatically when the Magic url parameter is detected on page load, so you are unlikely to need to call this function.
Arguments:
None.
Returns:
Promise<void>: A Promise that resolves when the token has been added to the Redux store.
Example:
The login function should be called when a user submits a login form. It will trigger an email to the user for verification.
Arguments:
login({ email, showUI, redirectURI })
Argument | Type | Description |
String | The user's email address. | |
showUI? | Boolean (optional, defaults to false) | Controls whether Magic's default UI will display from when login is called until the user clicks the link they've received in an email. |
redirectURI? | String (optional, defaults to window.location.href) | The URL that the user will be redirected to when they click the link they've received in an email. |
Returns:
Promise<void>
Example:
The logout function terminates the user's current session.
Arguments:
None.
Returns:
Promise<void>: A Promise that resolves when the session has been cleared.
Example: