important

This is a contributors guide and NOT a user guide. Please visit these docs if you are using or evaluating SuperTokens.

Separate API for post login account linking

Status:: accepted
Deciders:: rishabhpoddar, bhumilsarvaiya
Proposed by:: bhumilsarvaiya
Created:: 2022-11-30
Last updated:: 2022-12-01

Context and Problem Statement#

Should we use existing signup API for post login account linking or should there be a different API for the same?

Considered Options#

use signup API to also do account linking post login
have separate API for account linking post login

Decision Outcome#

Chosen option: have separate API for account linking post login, because

Purposes are very different of the normal sign up vs post login account linking API
We do not want to pollute the output types of normal sign up API for people who are not using account linking
The things you want to do post sign up are most likely different compared to what you want to do in the post login account linking API. Having them both as the same API, causes issues in which users might end up doing post sign up stuff even in post login account linking API (by mistake).

Pros and Cons of the Options#

use signup API to also do account linking post login#

Further details if necessary

It is not necessary that there will be a signup always. There can also be an existing account that can get linked during this API. Thus having account linking functionality in signup API is not semantically correct

Purposes are very different of the normal sign up vs post login account linking API

The things user may want to do post sign up are most likely different compared to what they may want to do in the post login account linking API. Having them both as the same API, causes issues in which users might end up doing post sign up stuff even in post login account linking API (by mistake).

have separate API for account linking post login#

See reasons listed in Decision outcome