The Auth Folder comprises of the following endpoints necessary for user creation, authentication and authorization.1. Sign Up (/auth/sign-up/)#
An endpoint to initiate user's registration.
Once all requirements are satisfied, an OTP should be generated and sent to the registered email, if the "authType"="password"
.
Registration isn't complete if the OTP hasn't been verified, in fact, if while that hasn't been verified and the request on "sign-up"
is repeated with the same email address, it won't give an error but should only update the OTP code.
However, if the OTP has been verified and the a "sign-up"
request is made again, with the same email address, then an error shall occur; that an email is unique to an instance alone.If the "authType"="provider"
, OTP is not needed; it's believed the verification has been done at the client-side, backed with another authentication at the server-side; only the Headers "Authorization"
is required.2. Sign In (/auth/sign-in/)#
Authenticate a registered user with this endpoint, with the required params.3. Authenticate a User (/auth/)#
Ensure you check the required params of each endpoint you need to invoke.
Modified at 2024-11-06 10:57:37