The GET /api/auth/linked/return method retrieves the original user's authentication token after a linked account has been accessed or modified. This endpoint ensures that the user can return to their original session, maintaining the integrity and security of their authentication state.
Purpose:
- Return to the Original Session: After a user has accessed or interacted with a linked account, this endpoint allows them to return to their original account by retrieving the initial authentication token.
- Maintain Security: Ensures that the original user's authentication token is restored and up-to-date, reflecting the current authentication state.
Response:
Upon a successful request, the server returns the original authentication token of the user. If there is an issue retrieving the original token (e.g., the user session has expired), an error response is returned
Key Features:
- This API method ensures the smooth transition back to the original user’s session, providing the original authentication token after interacting with a linked account.
- After a user has accessed a linked account (e.g., a business or sub-user account), they can use this endpoint to switch back to their original account by retrieving the initial token.
Summary:
The GET /api/auth/linked/return method allows a user to retrieve their original authentication token after accessing or interacting with a linked account. It ensures the user can return to their original session without re-authenticating, maintaining session security and user convenience. This API is particularly useful in scenarios involving multi-account management and helps maintain continuity of the user's original session, ensuring that the authentication state is preserved and secure.