Melody User Service API

auth-controller

Endpointhttps://melody-gateway-main-0d30d7f.d2.zuplo.dev

Register a new user

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/register

Creates a new user account with the provided information

Register a new user › Request Body

Data Transfer Object for user registration requests

email

string · required

Email address of the user

username

string · required

Username for the user account

password

string · minLength: 5 · maxLength: 20 · required

Password for the user account

Register a new user › Responses

User created successfully

Basic user response DTO for authentication and simple operations

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User region

isBlocked

boolean

Indicates if the user is blocked

contentFilterEnabled

boolean

Indicates if explicit content is blocked for the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

POST/auth/register

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "username": "johndoe",
  "password": "securePassword123"
}
'

shell

Example Request Body

{
  "email": "user@example.com",
  "username": "johndoe",
  "password": "securePassword123"
}

json

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "LISTENER",
  "region": "NAM",
  "isBlocked": false,
  "contentFilterEnabled": true,
  "createdAt": "2025-09-14T12:34:56Z"
}

json

application/json

Refresh access token

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/refresh

Generates a new access token using a valid refresh token

Refresh access token › Request Body

Request object for refreshing access tokens

refreshToken

string · required

Refresh token

Refresh access token › Responses

Token refreshed successfully

Data Transfer Object for authentication responses

token

string

JWT access token

tokenType

string

Token type

expiresIn

integer · int64

Token expiration time in seconds

refreshToken

string

Refresh token for obtaining new access tokens

object

Basic user response DTO for authentication and simple operations

POST/auth/refresh

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/refresh \
  --header 'Content-Type: application/json' \
  --data '
{
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000"
}
'

shell

Example Request Body

{
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000"
}

json

Example Responses

{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "tokenType": "Custom",
  "expiresIn": 3600,
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000",
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "user@example.com",
    "username": "johndoe",
    "role": "LISTENER",
    "region": "NAM",
    "isBlocked": false,
    "contentFilterEnabled": true,
    "createdAt": "2025-09-14T12:34:56Z"
  }
}

json

application/json

Logout user

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/logout

Revokes all refresh tokens for the authenticated user

Logout user › Responses

Logout successful - no content returned

No data returned

POST/auth/logout

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/logout

shell

Example Responses

No example specified for this content type

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/login

Authenticates a user with email and password, returning JWT access token and refresh token

Data Transfer Object for user login requests

email

string · required

Email address of the user

password

string · required

Password for the user account

Data Transfer Object for authentication responses

token

string

JWT access token

tokenType

string

Token type

expiresIn

integer · int64

Token expiration time in seconds

refreshToken

string

Refresh token for obtaining new access tokens

object

Basic user response DTO for authentication and simple operations

POST/auth/login

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "password": "securePassword123"
}
'

shell

Example Request Body

{
  "email": "user@example.com",
  "password": "securePassword123"
}

json

Example Responses

{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "tokenType": "Custom",
  "expiresIn": 3600,
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000",
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "user@example.com",
    "username": "johndoe",
    "role": "LISTENER",
    "region": "NAM",
    "isBlocked": false,
    "contentFilterEnabled": true,
    "createdAt": "2025-09-14T12:34:56Z"
  }
}

json

application/json

Get JSON Web Key Set (JWKS)

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/jwks

Retrieves the JWKS containing the public keys for verifying JWT tokens

Get JSON Web Key Set (JWKS) › Responses

200

JWKS retrieved successfully

string

GET/auth/jwks

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/jwks

shell

Example Responses

{
  "keys": [
    {
      "kty": "RSA",
      "alg": "RS256",
      "use": "sig",
      "kid": "key-id",
      "n": "base64url-encoded-modulus",
      "e": "base64url-encoded-exponent"
    }
  ]
}

json

application/json

Reset password

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/reset-password

Resets the user's password using a 6-digit token sent by email

Reset password › Request Body

DTO to reset the password using a token

token

string · minLength: 6 · maxLength: 6 · required

Password reset token

newPassword

string · minLength: 5 · maxLength: 20 · required

New password

confirmPassword

string · minLength: 5 · maxLength: 20 · required

Confirmation of the new password

Reset password › Responses

Password reset successfully - no content returned

No data returned

POST/auth/reset-password

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/reset-password \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "6-digit-token",
  "newPassword": "NewPassword123",
  "confirmPassword": "NewPassword123"
}
'

shell

Example Request Body

{
  "token": "6-digit-token",
  "newPassword": "NewPassword123",
  "confirmPassword": "NewPassword123"
}

json

Example Responses

No example specified for this content type

Request password reset

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/forgot-password

Generates a 6-digit token and sends it to the user's registered email

Request password reset › Request Body

DTO for requesting a password reset

email

string · required

Registered user's email

Request password reset › Responses

Password reset requested successfully - no content returned

No data returned

POST/auth/forgot-password

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@email.com"
}
'

shell

Example Request Body

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

json

Example Responses

No example specified for this content type

Get Firebase custom token

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/firebase-token

Generates a Firebase custom token for the authenticated user to access Firebase services

Get Firebase custom token › Responses

Firebase token generated successfully

Data Transfer Object for Firebase token response

firebaseToken

string

Firebase token for the user

GET/auth/firebase-token

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/firebase-token

shell

Example Responses

{
  "firebaseToken": "firebaseToken"
}

json

application/json

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/login/google

Authenticates a user using a Google ID token, returning JWT access token and refresh token

Data Transfer Object for Google login requests

idToken

string · required

Google ID token (JWT) returned from Google authentication

Data Transfer Object for authentication responses

token

string

JWT access token

tokenType

string

Token type

expiresIn

integer · int64

Token expiration time in seconds

refreshToken

string

Refresh token for obtaining new access tokens

object

Basic user response DTO for authentication and simple operations

POST/auth/login/google

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/login/google \
  --header 'Content-Type: application/json' \
  --data '
{
  "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ijc4OTYzIn0..."
}
'

shell

Example Request Body

{
  "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ijc4OTYzIn0..."
}

json

Example Responses

{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "tokenType": "Custom",
  "expiresIn": 3600,
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000",
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "user@example.com",
    "username": "johndoe",
    "role": "LISTENER",
    "region": "NAM",
    "isBlocked": false,
    "contentFilterEnabled": true,
    "createdAt": "2025-09-14T12:34:56Z"
  }
}

json

application/json

user-controller

Melody User Service API

auth-controller

Endpointhttps://melody-gateway-main-0d30d7f.d2.zuplo.dev

Register a new user

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/register

Creates a new user account with the provided information

Register a new user › Request Body

Data Transfer Object for user registration requests

email

string · required

Email address of the user

username

string · required

Username for the user account

password

string · minLength: 5 · maxLength: 20 · required

Password for the user account

Register a new user › Responses

User created successfully

Basic user response DTO for authentication and simple operations

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User region

isBlocked

boolean

Indicates if the user is blocked

contentFilterEnabled

boolean

Indicates if explicit content is blocked for the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

POST/auth/register

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "username": "johndoe",
  "password": "securePassword123"
}
'

shell

Example Request Body

{
  "email": "user@example.com",
  "username": "johndoe",
  "password": "securePassword123"
}

json

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "LISTENER",
  "region": "NAM",
  "isBlocked": false,
  "contentFilterEnabled": true,
  "createdAt": "2025-09-14T12:34:56Z"
}

json

application/json

Refresh access token

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/refresh

Generates a new access token using a valid refresh token

Refresh access token › Request Body

Request object for refreshing access tokens

refreshToken

string · required

Refresh token

Refresh access token › Responses

Token refreshed successfully

Data Transfer Object for authentication responses

token

string

JWT access token

tokenType

string

Token type

expiresIn

integer · int64

Token expiration time in seconds

refreshToken

string

Refresh token for obtaining new access tokens

object

Basic user response DTO for authentication and simple operations

POST/auth/refresh

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/refresh \
  --header 'Content-Type: application/json' \
  --data '
{
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000"
}
'

shell

Example Request Body

{
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000"
}

json

Example Responses

{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "tokenType": "Custom",
  "expiresIn": 3600,
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000",
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "user@example.com",
    "username": "johndoe",
    "role": "LISTENER",
    "region": "NAM",
    "isBlocked": false,
    "contentFilterEnabled": true,
    "createdAt": "2025-09-14T12:34:56Z"
  }
}

json

application/json

Logout user

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/logout

Revokes all refresh tokens for the authenticated user

Logout user › Responses

Logout successful - no content returned

No data returned

POST/auth/logout

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/logout

shell

Example Responses

No example specified for this content type

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/login

Authenticates a user with email and password, returning JWT access token and refresh token

Data Transfer Object for user login requests

email

string · required

Email address of the user

password

string · required

Password for the user account

Data Transfer Object for authentication responses

token

string

JWT access token

tokenType

string

Token type

expiresIn

integer · int64

Token expiration time in seconds

refreshToken

string

Refresh token for obtaining new access tokens

object

Basic user response DTO for authentication and simple operations

POST/auth/login

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "password": "securePassword123"
}
'

shell

Example Request Body

{
  "email": "user@example.com",
  "password": "securePassword123"
}

json

Example Responses

{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "tokenType": "Custom",
  "expiresIn": 3600,
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000",
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "user@example.com",
    "username": "johndoe",
    "role": "LISTENER",
    "region": "NAM",
    "isBlocked": false,
    "contentFilterEnabled": true,
    "createdAt": "2025-09-14T12:34:56Z"
  }
}

json

application/json

Get JSON Web Key Set (JWKS)

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/jwks

Retrieves the JWKS containing the public keys for verifying JWT tokens

Get JSON Web Key Set (JWKS) › Responses

200

JWKS retrieved successfully

string

GET/auth/jwks

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/jwks

shell

Example Responses

{
  "keys": [
    {
      "kty": "RSA",
      "alg": "RS256",
      "use": "sig",
      "kid": "key-id",
      "n": "base64url-encoded-modulus",
      "e": "base64url-encoded-exponent"
    }
  ]
}

json

application/json

Reset password

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/reset-password

Resets the user's password using a 6-digit token sent by email

Reset password › Request Body

DTO to reset the password using a token

token

string · minLength: 6 · maxLength: 6 · required

Password reset token

newPassword

string · minLength: 5 · maxLength: 20 · required

New password

confirmPassword

string · minLength: 5 · maxLength: 20 · required

Confirmation of the new password

Reset password › Responses

Password reset successfully - no content returned

No data returned

POST/auth/reset-password

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/reset-password \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "6-digit-token",
  "newPassword": "NewPassword123",
  "confirmPassword": "NewPassword123"
}
'

shell

Example Request Body

{
  "token": "6-digit-token",
  "newPassword": "NewPassword123",
  "confirmPassword": "NewPassword123"
}

json

Example Responses

No example specified for this content type

Request password reset

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/forgot-password

Generates a 6-digit token and sends it to the user's registered email

Request password reset › Request Body

DTO for requesting a password reset

email

string · required

Registered user's email

Request password reset › Responses

Password reset requested successfully - no content returned

No data returned

POST/auth/forgot-password

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@email.com"
}
'

shell

Example Request Body

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

json

Example Responses

No example specified for this content type

Get Firebase custom token

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/firebase-token

Generates a Firebase custom token for the authenticated user to access Firebase services

Get Firebase custom token › Responses

Firebase token generated successfully

Data Transfer Object for Firebase token response

firebaseToken

string

Firebase token for the user

GET/auth/firebase-token

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/firebase-token

shell

Example Responses

{
  "firebaseToken": "firebaseToken"
}

json

application/json

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/auth/login/google

Authenticates a user using a Google ID token, returning JWT access token and refresh token

Data Transfer Object for Google login requests

idToken

string · required

Google ID token (JWT) returned from Google authentication

Data Transfer Object for authentication responses

token

string

JWT access token

tokenType

string

Token type

expiresIn

integer · int64

Token expiration time in seconds

refreshToken

string

Refresh token for obtaining new access tokens

object

Basic user response DTO for authentication and simple operations

POST/auth/login/google

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/auth/login/google \
  --header 'Content-Type: application/json' \
  --data '
{
  "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ijc4OTYzIn0..."
}
'

shell

Example Request Body

{
  "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ijc4OTYzIn0..."
}

json

Example Responses

{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "tokenType": "Custom",
  "expiresIn": 3600,
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000",
  "user": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "user@example.com",
    "username": "johndoe",
    "role": "LISTENER",
    "region": "NAM",
    "isBlocked": false,
    "contentFilterEnabled": true,
    "createdAt": "2025-09-14T12:34:56Z"
  }
}

json

application/json

user-controller

auth-controller

Register a new user

Register a new user › Request Body

Register a new user › Responses

Refresh access token

Refresh access token › Request Body

Refresh access token › Responses

Logout user

Logout user › Responses

Login user

Login user › Request Body

Login user › Responses

Get JSON Web Key Set (JWKS)

Get JSON Web Key Set (JWKS) › Responses

Reset password

Reset password › Request Body

Reset password › Responses

Request password reset

Request password reset › Request Body

Request password reset › Responses

Get Firebase custom token

Get Firebase custom token › Responses

Login with Google

Login with Google › Request Body

Login with Google › Responses

auth-controller

Register a new user

Register a new user › Request Body

Register a new user › Responses

Refresh access token

Refresh access token › Request Body

Refresh access token › Responses

Logout user

Logout user › Responses

Login user

Login user › Request Body

Login user › Responses

Get JSON Web Key Set (JWKS)

Get JSON Web Key Set (JWKS) › Responses

Reset password

Reset password › Request Body

Reset password › Responses

Request password reset

Request password reset › Request Body

Request password reset › Responses

Get Firebase custom token

Get Firebase custom token › Responses

Login with Google

Login with Google › Request Body

Login with Google › Responses