Auth

This page describes all endpoint in Auth Controller

GET

Gets the profile of the authenticated user.

GET/auth/me

Response

200401

User profile retrieved successfully

Body

application/json

idnumber

Example: 1

emailstring

Example: "[e-mail]"

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

rolesarray of string

isTwoFactorEnableboolean

Example: true

photostring

Example: "https://example.com/photo.jpg"

Request

JavaScriptCurlPython

const response = await fetch('/auth/me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401

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

POST

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

POST/auth/sign-in

Body

application/json

Send user credentials

credentialsobject

captchaTokenstring

Example: "captcha_token"

Response

200400

Successful authentication

Body

application/json

accessTokenstring

Example: "access_token"

refreshTokenstring

Example: "refresh_token"

isTwoFactorEnableboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/auth/sign-in', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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

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

POST/auth/sign-up

Body

application/json

User registration data

emailstring

Example: "[e-mail]"

passwordstring

Example: "user12345"

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

Response

201400403

User successfully registered

Body

application/json

accessTokenstring

Example: "access_token"

refreshTokenstring

Example: "refresh_token"

isTwoFactorEnableboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/auth/sign-up', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400403

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

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

POST/auth/google/sign-in

Body

application/json

Google OAuth user data

tokenstring

Example: "google_oauth_token"

Response

200400

Successful authentication

Body

application/json

accessTokenstring

Example: "access_token"

refreshTokenstring

Example: "refresh_token"

isTwoFactorEnableboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/auth/google/sign-in', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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

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

POST/auth/google/sign-up

Body

application/json

Google OAuth user data

tokenstring

Example: "google_oauth_token"

Response

201400403

User successfully registered

Body

application/json

accessTokenstring

Example: "access_token"

refreshTokenstring

Example: "refresh_token"

isTwoFactorEnableboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/auth/google/sign-up', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400403

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

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

POST/auth/facebook/sign-in

Body

application/json

Facebook OAuth user data

tokenstring

Example: "facebook_oauth_token"

Response

200400

Successful authentication

Body

application/json

accessTokenstring

Example: "access_token"

refreshTokenstring

Example: "refresh_token"

isTwoFactorEnableboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/auth/facebook/sign-in', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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

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

POST/auth/facebook/sign-up

Body

application/json

Facebook OAuth user data

tokenstring

Example: "facebook_oauth_token"

Response

201400403

User successfully registered

Body

application/json

accessTokenstring

Example: "access_token"

refreshTokenstring

Example: "refresh_token"

isTwoFactorEnableboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/auth/facebook/sign-up', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400403

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

Refreshes the access token using a valid refresh token.

POST/auth/refresh-token

Body

application/json

Refresh token data

refreshTokenstring

Example: "valid_refresh_token"

Response

200401

Tokens refreshed successfully

Body

application/json

accessTokenstring

Example: "new_access_token"

refreshTokenstring

Example: "new_refresh_token"

isTwoFactorEnableboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/auth/refresh-token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401

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

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

POST/auth/forgot-password

Body

application/json

Email address for password reset

emailstring

Example: "[e-mail]"

Response

200400

Password reset link sent successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/auth/forgot-password', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "message": "Password restoration email send",
  "description": "<p>Check your email for further instructions on how to change your password.</p>",
  "__$markdownParsed": true
}

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

POST/auth/validate-restore-token

Body

application/json

Restore token data

tokenstring

Example: "valid_restore_token"

Response

200400

Token is valid

Body

application/json

any

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/auth/validate-restore-token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

true

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

POST/auth/validate-invitation-token

Body

application/json

Invitation token data

tokenstring

Example: "valid_invitation_token"

Response

200400

Token is valid

Body

application/json

any

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/auth/validate-invitation-token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

true

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

POST/auth/restore-password

Body

application/json

Restore password data

newPassword*string

New password for the user

Example: "newSecurePassword123"

token*string

Token for password restoration

Example: "someRandomToken123"

Response

200400500

Password restored successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/auth/restore-password', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "newPassword": "newSecurePassword123",
      "token": "someRandomToken123"
    }),
});
const data = await response.json();

Response

200400500

{
  "message": "Password restored successfully",
  "description": "<p>Your password has been changed successfully.</p>",
  "__$markdownParsed": true
}

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

POST/auth/finish-invitation

Body

application/json

Finish invitation data

newPassword*string

New password for the user

Example: "newSecurePassword123"

token*string

Token for registration completion

Example: "someRandomToken123"

firstName*string

First name of the user

Example: "John"

lastName*string

Last name of the user

Example: "Doe"

Response

200400500

Invitation finished successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/auth/finish-invitation', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "newPassword": "newSecurePassword123",
      "token": "someRandomToken123",
      "firstName": "John",
      "lastName": "Doe"
    }),
});
const data = await response.json();

Response

200400500

{
  "message": "Invitation finished successfully",
  "description": "<p>Your account has been activated and your password has been set successfully.</p>",
  "__$markdownParsed": true
}

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

POST/auth/change-team

Body

application/json

Team change data

teamIdstring

Example: "team_id"

Response

200400403

Team changed successfully

Body

application/json

accessTokenstring

Example: "new_access_token"

refreshTokenstring

Example: "new_refresh_token"

isTwoFactorEnableboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('/auth/change-team', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403

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