The Authentication Management service handles user authentication, registration, token management, and account verification operations.

Authentication Operations

Activate User Account `POST` /api/v1/auth/{userId}/active

Resource URL	/api/v1/auth/{userId}/active
Response Format	JSON
Requires Authentication	No
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description	Required
userId	ID of user to activate	Yes

Request Body

{
	"verificationCode": "123456"
}

Example Request

curl -X 'POST' \
'https://um.braegen.ai/api/v1/auth/1/active' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '"123456"'

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "User activated successfully",
	"data": {
		"userId": 1,
		"isActive": true
	}
}

Register New User `POST` /api/v1/auth/register

Resource URL	/api/v1/auth/register
Response Format	JSON
Requires Authentication	No
Rate Limited	Yes
HTTPS	Yes

Request Body (multipart/form-data)

Field	Type	Required	Description
email	string	Yes	User's email address
password	string	Yes	User's password
firstName	string	Yes	User's first name
middleName	string	No	User's middle name
lastName	string	No	User's last name
phoneNumber	string	No	User's phone number
file	binary	No	Profile picture

Example Request

curl -X 'POST' \
'https://um.braegen.ai/api/v1/auth/register' \
-H 'accept: */*' \
-H 'Content-Type: multipart/form-data' \
-F '[email protected]' \
-F 'password=password123' \
-F 'firstName=John' \
-F 'lastName=Doe' \
-F '[email protected]'

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "User registered successfully",
	"data": {
		"id": 1,
		"email": "[email protected]",
		"firstName": "John",
		"lastName": "Doe"
	},
	"emailSent": true
}

Refresh Authentication Token `POST` /api/v1/auth/refresh-token

Resource URL	/api/v1/auth/refresh-token
Response Format	JSON
Requires Authentication	Yes (Refresh Token)
Rate Limited	Yes
HTTPS	Yes

Request Body

{
	"refresh_token": "eyJhbGciOiJIUzI1..."
}

Example Request

curl -X 'POST' \
'https://um.braegen.ai/api/v1/auth/refresh-token' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '"eyJhbGciOiJIUzI1..."'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"access_token": "eyJhbGciOiJIUzI1...",
		"refresh_token": "eyJhbGciOiJIUzI1..."
	}
}

Logout User `POST` /api/v1/auth/logout

Resource URL	/api/v1/auth/logout
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Example Request

curl -X 'POST' \
'https://um.braegen.ai/api/v1/auth/logout' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}'

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "Logged out successfully",
	"data": null
}

Form Authentication `POST` /api/v1/auth/form-authenticate

Resource URL	/api/v1/auth/form-authenticate
Response Format	JSON
Requires Authentication	No
Rate Limited	Yes
HTTPS	Yes

Query Parameters

Parameter	Type	Required	Description
username	string	Yes	User's email/username
password	string	Yes	User's password

Example Request

curl -X 'POST' \
'https://um.braegen.ai/api/v1/auth/[email protected]&password=password123' \
-H 'accept: */*'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"access_token": "eyJhbGciOiJIUzI1...",
		"refresh_token": "eyJhbGciOiJIUzI1..."
	}
}

Authenticate User `POST` /api/v1/auth/authenticate

Resource URL	/api/v1/auth/authenticate
Response Format	JSON
Requires Authentication	No
Rate Limited	Yes
HTTPS	Yes

Request Body

{
	"email": "[email protected]",
	"password": "password123"
}

Example Request

curl -X 'POST' \
'https://um.braegen.ai/api/v1/auth/authenticate' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
    "email": "[email protected]",
    "password": "password123"
}'

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": {
		"access_token": "eyJhbGciOiJIUzI1...",
		"refresh_token": "eyJhbGciOiJIUzI1..."
	}
}

Resend Verification Code `GET` /api/v1/auth/{userId}/resend-verify-code

Resource URL	/api/v1/auth/{userId}/resend-verify-code
Response Format	JSON
Requires Authentication	No
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description	Required
userId	ID of user to resend verification code	Yes

Example Request

curl -X 'GET' \
'https://um.braegen.ai/api/v1/auth/1/resend-verify-code' \
-H 'accept: */*'

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "Verification code sent successfully",
	"data": {
		"userId": 1
	},
	"emailSent": true
}

HTTP Response Codes

HTTP Code	Message
200	Success
400	Bad Request
401	Unauthorized
403	Invalid Input
404	Invalid or not found type

Common Error Responses

Invalid Credentials

{
	"success": false,
	"status": "401 UNAUTHORIZED",
	"message": "Invalid email or password",
	"data": null
}

Invalid Token

{
	"success": false,
	"status": "401 UNAUTHORIZED",
	"message": "Invalid or expired token",
	"data": null
}

Registration Error

{
	"success": false,
	"status": "400 BAD_REQUEST",
	"message": "Email already registered",
	"data": null
}

Verification Error

{
	"success": false,
	"status": "400 BAD_REQUEST",
	"message": "Invalid verification code",
	"data": null
}

Authentication Management

Authentication Operations

Activate User Account POST /api/v1/auth/{userId}/active

Register New User POST /api/v1/auth/register

Refresh Authentication Token POST /api/v1/auth/refresh-token

Logout User POST /api/v1/auth/logout

Form Authentication POST /api/v1/auth/form-authenticate

Authenticate User POST /api/v1/auth/authenticate

Resend Verification Code GET /api/v1/auth/{userId}/resend-verify-code

HTTP Response Codes

Common Error Responses

On this page

Activate User Account `POST` /api/v1/auth/{userId}/active

Register New User `POST` /api/v1/auth/register

Refresh Authentication Token `POST` /api/v1/auth/refresh-token

Logout User `POST` /api/v1/auth/logout

Form Authentication `POST` /api/v1/auth/form-authenticate

Authenticate User `POST` /api/v1/auth/authenticate

Resend Verification Code `GET` /api/v1/auth/{userId}/resend-verify-code