The User Management Service provides comprehensive user management functionality including user CRUD operations, email-based lookups, password management, and client/tenant relationships.

User Operations

Get User by ID `GET` /api/v1/user/{userId}

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

Parameters

Parameter	Description	Required
userId	ID of user to retrieve	Yes

Example Request

curl -X 'GET' \
'https://um.braegen.ai/api/v1/user/1' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}'

Example Response

{
	"id": 1,
	"email": "[email protected]",
	"firstName": "analyst",
	"lastName": "analyst",
	"phoneNumber": "123-456-7890",
	"profilePicture": "avatar-1.jpg",
	"aboutMe": "Passionate about technology.",
	"isActive": true
}

Update User `PUT` /api/v1/user/{userId}

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

Parameters

Parameter	Description	Required
userId	ID of user to update	Yes

Request Body

{
	"email": "[email protected]",
	"firstName": "analyst",
	"lastName": "analyst",
	"phoneNumber": "123-456-7890",
	"profilePicture": "avatar-1.jpg",
	"aboutMe": "Passionate about technology."
}

Example Request

curl -X 'PUT' \
'https://um.braegen.ai/api/v1/user/1' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{
    "email": "[email protected]",
    "firstName": "analyst"
}'

Delete User `DELETE` /api/v1/user/{userId}

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

Parameters

Parameter	Description	Required
userId	ID of user to delete	Yes

Example Request

curl -X 'DELETE' \
'https://um.braegen.ai/api/v1/user/18' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}'

Get All Users `GET` /api/v1/user

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

Query Parameters

Parameter	Description	Required
page	Page number for pagination	Yes
size	Number of records per page	Yes

Example Request

curl -X 'GET' \
'https://um.braegen.ai/api/v1/user?page=0&size=10' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}'

Create User `POST` /api/v1/user

Resource URL	/api/v1/user
Response Format	JSON
Requires Authentication	Yes
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
lastName	string	No	User's last name
phoneNumber	string	No	User's phone number
aboutMe	string	No	User's description
file	binary	No	Profile picture

Example Request

curl -X 'POST' \
'https://um.braegen.ai/api/v1/user' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: multipart/form-data' \
-F '[email protected]' \
-F 'password=analyst' \
-F 'firstName=analyst'

Get Users by Email List `GET` /api/v1/user/by-email

Resource URL	/api/v1/user/by-email
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Query Parameters

Parameter	Type	Required	Description
emails	array	Yes	List of email addresses

Example Request

curl -X 'GET' \
'https://um.braegen.ai/api/v1/user/[email protected],[email protected]' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}'

Search Users by Email (POST) `POST` /api/v1/user/by-email

Resource URL	/api/v1/user/by-email
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Request Body

["[email protected]", "[email protected]"]

Example Request

curl -X 'POST' \
'https://um.braegen.ai/api/v1/user/by-email' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '["[email protected]", "[email protected]"]'

Reset Password `PATCH` /api/v1/user/{userId}/password-reset

Resource URL	/api/v1/user/{userId}/password-reset
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description	Required
userId	ID of user to reset password	Yes

Request Body

{
	"currentPassword": "oldPassword123"
}

Example Request

curl -X 'PATCH' \
'https://um.braegen.ai/api/v1/user/1/password-reset' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{"currentPassword": "oldPassword123"}'

Change Password `PATCH` /api/v1/user/{userId}/change-password

Resource URL	/api/v1/user/{userId}/change-password
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description	Required
userId	ID of user to change password	Yes

Request Body

{
	"currentPassword": "oldPassword123",
	"newPassword": "newPassword123"
}

Example Request

curl -X 'PATCH' \
'https://um.braegen.ai/api/v1/user/1/change-password' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{"currentPassword": "oldPassword123", "newPassword": "newPassword123"}'

Get Client and Tenant Information `GET` /api/v1/user/{userId}/client-and-tenant

Resource URL	/api/v1/user/{userId}/client-and-tenant
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description	Required
userId	ID of user to get client/tenant info	Yes

Example Request

curl -X 'GET' \
'https://um.braegen.ai/api/v1/user/1/client-and-tenant' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}'

Example Response

{
	"clientId": 1,
	"tenantId": 1
}

Get User by Email `GET` /api/v1/user/by-email/{email}

Resource URL	/api/v1/user/by-email/{email}
Response Format	JSON
Requires Authentication	Yes
Rate Limited	Yes
HTTPS	Yes

Parameters

Parameter	Description	Required
email	Email address of user	Yes

Example Request

curl -X 'GET' \
'https://um.braegen.ai/api/v1/user/by-email/[email protected]' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}'

HTTP Response Codes

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

All endpoints require proper authentication through Bearer token in the Authorization header. The token should be included in all API requests in the headers:

Authorization: Bearer {token}

User Operations

User Operations

Get User by ID GET /api/v1/user/{userId}

Update User PUT /api/v1/user/{userId}

Delete User DELETE /api/v1/user/{userId}

Get All Users GET /api/v1/user

Create User POST /api/v1/user

Get Users by Email List GET /api/v1/user/by-email

Search Users by Email (POST) POST /api/v1/user/by-email

Reset Password PATCH /api/v1/user/{userId}/password-reset

Change Password PATCH /api/v1/user/{userId}/change-password

Get Client and Tenant Information GET /api/v1/user/{userId}/client-and-tenant

Get User by Email GET /api/v1/user/by-email/{email}

HTTP Response Codes

On this page

Get User by ID `GET` /api/v1/user/{userId}

Update User `PUT` /api/v1/user/{userId}

Delete User `DELETE` /api/v1/user/{userId}

Get All Users `GET` /api/v1/user

Create User `POST` /api/v1/user

Get Users by Email List `GET` /api/v1/user/by-email

Search Users by Email (POST) `POST` /api/v1/user/by-email

Reset Password `PATCH` /api/v1/user/{userId}/password-reset

Change Password `PATCH` /api/v1/user/{userId}/change-password

Get Client and Tenant Information `GET` /api/v1/user/{userId}/client-and-tenant

Get User by Email `GET` /api/v1/user/by-email/{email}