Accounts

Authentication

Get Account

GET https://demo.getlynx.dev/api/auth/me

Headers

Name	Type	Description
Authorization	String	Your API key

Cookies

Name	Type	Description
token	String	Your JWT Session

200: OK Account successfully returned

{
    "success": true,
    "result":{
        "id":"be8881ce-af01-433b-a675-fe02e8a48a88",
        "username":"demo",
        "email":"[e-mail]",
        "role":"standard",
        "secret":"uihJEIwC0jjGIF0BhZnY7xI90jN664La",
        "totp": false,
    }
}

401: Unauthorized

500: Internal Server Error

Log In

POST https://demo.getlynx.dev/api/auth/login

Request Body

Name	Type	Description
username*	String
password*	String
token	String	2FA Token

200: OK Successfully logged in

// Returns set-cookie header set to JWT Session under "token"
{
    "success": true,
    "message": "Successfully logged in!",
}

403: Forbidden Invalid username or password

500: Internal Server Error

403: Forbidden 2FA token required

{
    "success": false,
    "message": "2FA token required",
}

Register

POST https://demo.getlynx.dev/api/auth/register

Request Body

Name	Type	Description
username*	String
password*	String
email*	String

200: OK Successfully created account

{
    "success": true,
    "result": "Account created",
}

500: Internal Server Error

400: Bad Request Invalid field(s)

{
  "success": false,
  "message": "Invalid field(s)",
  "details": {
      "invalid": {
          "email": false,
          "username": false,
          "password": true,
      },
  },  
}

400: Bad Request Field(s) are already used

{
  "success": false,
  "message": "Field(s) are already used",
  "details": {
      "exists": {
          "email": true,
          "username": true,
          "password": false,
      },
  },  
}

412: Precondition Failed Registration is not enabled

Occurs when at least 1 account exists and ENABLE_REGISTRATION is set to false

Log Out

DELETE https://demo.getlynx.dev/api/auth/me

Cookies

Name	Type	Description
token*	String	Your JWT Session

200: OK Account successfully logged out

// Cookie token is cleared
{
    "success": true,
    "message": "Successfully logged out",
}

Two-Factor Authentication (2FA)

Get new TOTP token

GET https://demo.getlynx.dev/api/auth/totp

Cookies

Name	Type	Description
token	String	Your JWT Session

200: OK New TOTP token generated

{
    "success": true,
    "message": "TOTP secret successfully generated",
    "result":{
        "secret": "H6NYN2R23UB6KGAC3O6TARUVN773MBWT",
        "uri": "otpauth://totp/Lynx:admin?issuer=Lynx&secret=H6NYN2R23UB6KGAC3O6TARUVN773MBWT&algorithm=SHA1&digits=6&period=30"
    }
}

401: Unauthorized

500: Internal Server Error

406: Not Acceptable Enabling 2FA is not supported in demo mode.

412: Precondition Failed 2FA already enabled

Enable 2FA

POST https://demo.getlynx.dev/api/auth/totp

Cookies

Name	Type	Description
token	String	Your JWT Session

Request Body

Name	Type	Description
token*	String	2FA Token

200: OK 2FA successfully enabled

{
    "success": true,
    "message": "2FA successfully enabled",
    "result":{
        "backupCodes": ["57E5ht9zD1d3", "6bllbg1122Qc", "76A7n7AHEm0r", "6VL2z2W151L5", "fQxPJJ6AYTu2", "S2uZ7A12k551"],
    }
}

401: Unauthorized

500: Internal Server Error

406: Not Acceptable Enabling 2FA is not supported in demo mode.

412: Precondition Failed 2FA process hasn't been started

412: Precondition Failed 2FA already enabled, no need to verify

412: Precondition Failed Invalid token format

Disable 2FA

DELETE https://demo.getlynx.dev/api/auth/totp

Cookies

Name	Type	Description
token	String	Your JWT Session

Request Body

Name	Type	Description
token	String	2FA Token

200: OK 2FA successfully disabled

{
    "success": true,
    "message": "2FA has been successfully disabled",
}

401: Unauthorized

500: Internal Server Error

403: Forbidden Expired or invalid TOTP token

Account Recovery

Recover Account

POST https://demo.getlynx.dev/api/auth/totp/recover

Request Body

Name	Type	Description
backupCode*	String
password*	String
username*	String

200: OK 2FA has been disabled and you have been logged in

// Returns set-cookie header set to JWT Session under "token"
{
    "success": true,
    "message": "2FA has been disabled and you have been logged in",
}

500: Internal Server Error

412: Precondition Failed 2FA is not enabled

403: Forbidden Invalid username or password

403: Forbidden Invalid backup code

Manual Recovery

If you didn't save your backup codes you will need to run the following commands in your mongodb container/instance

Connect to your database and enter your password:

mongosh --port 27017 --username user --authenticationDatabase admin

Switch to the lynx database:

use shortener

Disable 2FA for your account's username:

db.accounts.findOneAndUpdate({ username: "user2" },{ $set:{ "totp.enabled":false } })

Account Information Management

Update Email

PATCH https://demo.getlynx.dev/api/auth/email

Cookies

Name	Type	Description
token*	String	Your JWT Session

Request Body

Name	Type	Description
newEmail*	String
password*	String
token	String	2FA Token (If Enabled)

200: OK Successfully updated email

{
    "success": true,
    "result": "Email successfully updated",
}

500: Internal Server Error

406: Not Acceptable Updating of credentials is not enabled in demo mode.

400: Bad Request Invalid password

Update Password

PATCH https://demo.getlynx.dev/api/auth/password

Cookies

Name	Type	Description
token*	String	Your JWT Session

Request Body

Name	Type	Description
password*	String
newPassword*	String
token	String	2FA Token (If Enabled)

200: OK Successfully updated password

{
    "success": true,
    "result": "Password successfully updated",
}

500: Internal Server Error

406: Not Acceptable Updating of credentials is not enabled in demo mode.

400: Bad Request Invalid password

Update Username

PATCH https://demo.getlynx.dev/api/auth/username

Cookies

Name	Type	Description
token*	String	Your JWT Session

Request Body

Name	Type	Description
newUsername*	String
password*	String
token	String	2FA Token (If Enabled)

200: OK Successfully updated username

{
    "success": true,
    "result": "Username successfully updated",
}

500: Internal Server Error

406: Not Acceptable Updating of credentials is not enabled in demo mode.

400: Bad Request Invalid password

Other

Get new secret

POST https://demo.getlynx.dev/api/auth/newSecret

200: OK New Secret generated

{
    "success": true,
    "result":{
        "secret": "uihJEIwC0jjGIF0BhZnY7xI90jN664La",
    }
}

401: Unauthorized

500: Internal Server Error