Comment on page
Auth
This documentation provides details about the authentication endpoints for user sign-up, login, password reset, and password recovery.
- 1.Signup
- 2.Login
- 3.Reset Password
- 4.Forgot Password
Allows a user to sign up with their email and password.
- Endpoint:
/auth/signup - Method: POST
- Description: Lets a user sign up with their email and password.
- Consumes: application/json
- Produces: application/json
- Tags: auth
- Summary: Allows a user to sign up.
Oops, something is missing.We could not find the original source to display this content.
Request Parameters
Name | Type | Description | In | Required |
|---|---|---|---|---|
signup | object | User signup information | body | Yes |
- email | string | User's email | body | Yes |
- password | string | User's password | body | Yes |
Responses
Status Code | Description | Schema |
|---|---|---|
200 | OK | UserSignupRes |
400 | Bad Request | ClientError |
401 | Unauthorized | ClientError |
409 | Conflict | ClientError |
500 | Internal Server Error | ClientError |
Allows a user to log in using their email and password.
- Endpoint:
/auth/login - Method: POST
- Description: Lets a user log in with their email and password.
- Consumes: application/json
- Produces: application/json
- Tags: auth
- Summary: Allows a user to log in.
Oops, something is missing.We could not find the original source to display this content.
Request Parameters
Name | Type | Description | In | Required |
|---|---|---|---|---|
login | object | User login information | body | Yes |
- email | string | User's email | body | Yes |
- password | string | User's password | body | Yes |
Responses
Status Code | Description | Schema |
|---|---|---|
200 | OK | Object with access_token |
400 | Bad Request | ClientError |
401 | Unauthorized | ClientError |
500 | Internal Server Error | ClientError |
Allows a user to update their password using a reset token received via email.
- Endpoint:
/auth/reset_password - Method: POST
- Description: Lets a user update their password using a reset token.
- Consumes: application/json
- Produces: application/json
- Tags: auth
- Summary: Allows a user to update their password.
Oops, something is missing.We could not find the original source to display this content.
Request Parameters
Name | Type | Description | In | Required |
|---|---|---|---|---|
password | object | New password and token | body | Yes |
- token | string | Reset token | body | Yes |
- new password | string | New password | body | Yes |
Responses
Status Code | Description | Schema |
|---|---|---|
200 | OK | Object with success message |
400 | Bad Request | ClientError |
401 | Unauthorized | ClientError |
500 | Internal Server Error | ClientError |
Allows a user to initiate the process of resetting their password by providing their email.
- Endpoint:
/auth/forgot_password - Method: GET
- Description: Initiates password reset process via email.
- Consumes: application/json
- Produces: application/json
- Tags: auth
- Summary: Initiates password reset process via email.
Oops, something is missing.We could not find the original source to display this content.
Request Parameters
Name | Type | Description | In | Required |
|---|---|---|---|---|
email | string | User's email | query | Yes |
Responses
Status Code | Description | Schema |
|---|---|---|
200 | OK | Object with success message |
400 | Bad Request | ClientError |
500 | Internal Server Error | ClientError |
Please note that the schemas and definitions referenced in this documentation should be defined in your API specification separately. The information provided here is for documentation purposes only.
Last modified 3mo ago