Auth

This page describes all endpoint in Auth Controller

GET

Gets the profile of the authenticated user.

get

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/auth/me'

200

401

200

{
  "id": 1,
  "email": "[e-mail]",
  "firstName": "John",
  "lastName": "Doe",
  "roles": [
    "User"
  ],
  "isTwoFactorEnable": true,
  "photo": "https://example.com/photo.jpg"
}

User profile retrieved successfully

POST

Authenticates a user, verifies their captchaToken, and returns tokens for session management along with their two-factor authentication status.

post

Body

credentialsobjectoptional

captchaTokenstringoptional

Example: captcha_token

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/sign-in' \
  --header 'Content-Type: application/json' \
  --data '{
    "credentials": {
      "email": "[e-mail]",
      "password": "user12345"
    },
    "captchaToken": "captcha_token"
  }'

200

400

200

{
  "accessToken": "access_token",
  "refreshToken": "refresh_token",
  "isTwoFactorEnable": true
}

Successful authentication

Registers a new user with email and password and returns tokens for session management.

post

Body

emailstringoptional

Example: [e-mail]

passwordstringoptional

Example: user12345

firstNamestringoptional

Example: John

lastNamestringoptional

Example: Doe

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/sign-up' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "password": "user12345",
    "firstName": "John",
    "lastName": "Doe"
  }'

201

400

403

201

{
  "accessToken": "access_token",
  "refreshToken": "refresh_token",
  "isTwoFactorEnable": true
}

User successfully registered

Authenticates a user using Google OAuth and returns tokens for session management.

post

Body

tokenstringoptional

Example: google_oauth_token

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/google/sign-in' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "google_oauth_token"
  }'

200

400

200

{
  "accessToken": "access_token",
  "refreshToken": "refresh_token",
  "isTwoFactorEnable": true
}

Successful authentication

Registers a new user using Google OAuth and returns tokens for session management.

post

Body

tokenstringoptional

Example: google_oauth_token

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/google/sign-up' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "google_oauth_token"
  }'

201

400

403

201

{
  "accessToken": "access_token",
  "refreshToken": "refresh_token",
  "isTwoFactorEnable": true
}

User successfully registered

Authenticates a user using Facebook OAuth and returns tokens for session management.

post

Body

tokenstringoptional

Example: facebook_oauth_token

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/facebook/sign-in' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "facebook_oauth_token"
  }'

200

400

200

{
  "accessToken": "access_token",
  "refreshToken": "refresh_token",
  "isTwoFactorEnable": true
}

Successful authentication

Registers a new user using Facebook OAuth and returns tokens for session management.

post

Body

tokenstringoptional

Example: facebook_oauth_token

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/facebook/sign-up' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "facebook_oauth_token"
  }'

201

400

403

201

{
  "accessToken": "access_token",
  "refreshToken": "refresh_token",
  "isTwoFactorEnable": true
}

User successfully registered

Refreshes the access token using a valid refresh token.

post

Body

refreshTokenstringoptional

Example: valid_refresh_token

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/refresh-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "refreshToken": "valid_refresh_token"
  }'

200

401

200

{
  "accessToken": "new_access_token",
  "refreshToken": "new_refresh_token",
  "isTwoFactorEnable": true
}

Tokens refreshed successfully

Initiates the password reset process by sending a reset link to the user's email.

post

Body

emailstringoptional

Example: [e-mail]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/forgot-password' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]"
  }'

200

400

200

{
  "message": "Password restoration email send",
  "description": "Check your email for further instructions on how to change your password."
}

Password reset link sent successfully

Validates the restore token to ensure it is still valid and has not expired.

post

Body

tokenstringoptional

Example: valid_restore_token

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/validate-restore-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "valid_restore_token"
  }'

200

400

200

true

Token is valid

Validates the invitation token to ensure it is still valid and has not expired.

post

Body

tokenstringoptional

Example: valid_invitation_token

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/validate-invitation-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "valid_invitation_token"
  }'

200

400

200

true

Token is valid

Restores the user's password using a valid restore token.

post

Body

newPasswordstringrequired

Example: newSecurePassword123

tokenstringrequired

Example: someRandomToken123

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/restore-password' \
  --header 'Content-Type: application/json' \
  --data '{
    "newPassword": "newSecurePassword123",
    "token": "someRandomToken123"
  }'

200

400

500

200

{
  "message": "Password restored successfully",
  "description": "Your password has been changed successfully."
}

Password restored successfully

Completes the invitation process by setting the user's password and activating the account.

post

Body

newPasswordstringrequired

New password for the user

Example: newSecurePassword123

tokenstringrequired

Token for registration completion

Example: someRandomToken123

firstNamestringrequired

First name of the user

Example: John

lastNamestringrequired

Last name of the user

Example: Doe

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/finish-invitation' \
  --header 'Content-Type: application/json' \
  --data '{
    "newPassword": "newSecurePassword123",
    "token": "someRandomToken123",
    "firstName": "John",
    "lastName": "Doe"
  }'

200

400

500

200

{
  "message": "Invitation finished successfully",
  "description": "Your account has been activated and your password has been set successfully."
}

Invitation finished successfully

Changes the user's active team and returns new tokens for session management.

post

Body

teamIdstringoptional

Example: team_id

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/change-team' \
  --header 'Content-Type: application/json' \
  --data '{
    "teamId": "team_id"
  }'

200

400

403

200

{
  "accessToken": "new_access_token",
  "refreshToken": "new_refresh_token",
  "isTwoFactorEnable": true
}

Team changed successfully