Authentication API

The Authentication API provides methods for managing users and authentication processes.

Methods

1. Register

Registers a new user in the system.

Endpoint: POST /api/auth/register

Request Parameters:

{
  "username": "exampleUser",
  "email": "user@example.com",
  "password": "password123",
  "roles": ["user"]
}

2. Login

Authenticate the user with their credentials.

Endpoint: POST /api/auth/login

Request Parameters:

{
  "username": "exampleUser",
  "password": "password123"
}

3. ConfirmEmail

Confirm the user's email address after registration.

Endpoint: POST /api/auth/confirm-email

Request Parameters:

{
  "email": "user@example.com",
  "token": "confirmationToken123"
}

4. LoginWithOTP

Authenticate the user using a one-time password (OTP).

Endpoint: POST /api/auth/login-2FA

Request Parameters:

{
  "username": "exampleUser",
  "otp": "123456"
}

5. RefreshToken

Refresh the access token using a refresh token.

Endpoint: POST /api/auth/refresh-token

Request Parameters:

{
  "accessToken": {
    "token": "accessToken123",
    "expiryTokenDate": "2024-02-05T11:30:26.187Z"
  },
  "refreshToken": {
    "token": "refreshToken1234",
    "expiryTokenDate": "2024-02-05T11:30:26.187Z"
  }
}

6. ForgotPassword

Initiate the user password recovery process.

Endpoint: POST /api/auth/forgot-password

Request Parameters:

{
  "email": "user@example.com"
}

7. ResetPassword

Reset the user's password after a password reset request.

Endpoint: POST /api/auth/reset-password

Request Parameters:

{
  "password": "newPassword",
  "confirmPassword": "confirmPassword",
  "email": "user@example.com",
  "token": "token123"
}

Notes