BREAGEN Logo
User Management Service

Resource Management

The Resource Management service provides functionality to manage resources in the system, including creating, retrieving, updating, and deleting resources.

Resource Operations

Get Resource by ID GET /api/v1/resource/{resourceId}

Resource URL/api/v1/resource/{resourceId}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescriptionRequired
resourceIdID of resource to retrieveYes

Example Request

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

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "Resource retrieved successfully",
	"data": {
		"id": 1,
		"resourceName": "UserDashboard",
		"description": "User dashboard access resource"
	}
}

Update Resource PUT /api/v1/resource/{resourceId}

Resource URL/api/v1/resource/{resourceId}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescriptionRequired
resourceIdID of resource to updateYes

Request Body

{
	"resourceName": "UpdatedDashboard",
	"description": "Updated dashboard resource description"
}

Example Request

curl -X 'PUT' \
'https://um.braegen.ai/api/v1/resource/1' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{
    "resourceName": "UpdatedDashboard",
    "description": "Updated dashboard resource description"
}'

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "Resource updated successfully",
	"data": {
		"id": 1,
		"resourceName": "UpdatedDashboard",
		"description": "Updated dashboard resource description"
	}
}

Delete Resource DELETE /api/v1/resource/{resourceId}

Resource URL/api/v1/resource/{resourceId}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescriptionRequired
resourceIdID of resource to deleteYes

Example Request

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

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "Resource deleted successfully",
	"data": {
		"deleted_resource_id": 1
	}
}

Get All Resources GET /api/v1/resource

Resource URL/api/v1/resource
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Example Request

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

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": [
		{
			"id": 1,
			"resourceName": "UserDashboard",
			"description": "User dashboard access resource"
		},
		{
			"id": 2,
			"resourceName": "AdminPanel",
			"description": "Admin panel access resource"
		}
	]
}

Create Resource POST /api/v1/resource

Resource URL/api/v1/resource
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Request Body

{
	"resourceName": "NewResource",
	"description": "Description of the new resource"
}

Example Request

curl -X 'POST' \
'https://um.braegen.ai/api/v1/resource' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{
    "resourceName": "NewResource",
    "description": "Description of the new resource"
}'

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "Resource created successfully",
	"data": {
		"id": 3,
		"resourceName": "NewResource",
		"description": "Description of the new resource"
	}
}

HTTP Response Codes

HTTP CodeMessage
200Success
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404Invalid 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}

Previous

Resource Attribute Management

Next

User Attribute Controller

On this page