BREAGEN Logo
User Management Service

Policy Management

The Policy Management service provides functionality to manage access control policies, including creation, retrieval, updating, and deletion of policies.

Policy Operations

Get Policy by ID GET /api/v1/policy/{policyId}

Resource URL/api/v1/policy/{policyId}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescriptionRequired
policyIdID of policy to retrieveYes

Example Request

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

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "Policy retrieved successfully",
	"data": {
		"id": 1,
		"policyName": "AdminAccess"
	}
}

Update Policy PUT /api/v1/policy/{policyId}

Resource URL/api/v1/policy/{policyId}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescriptionRequired
policyIdID of policy to updateYes

Request Body

{
	"policyName": "UpdatedAdminPolicy"
}

Example Request

curl -X 'PUT' \
'https://um.braegen.ai/api/v1/policy/1' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{
    "policyName": "UpdatedAdminPolicy"
}'

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "Policy updated successfully",
	"data": {
		"id": 1,
		"policyName": "UpdatedAdminPolicy"
	}
}

Delete Policy DELETE /api/v1/policy/{policyId}

Resource URL/api/v1/policy/{policyId}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescriptionRequired
policyIdID of policy to deleteYes

Example Request

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

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "Policy deleted successfully",
	"data": {
		"deleted_policy_id": 1
	}
}

Get All Policies GET /api/v1/policy

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

Example Request

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

Example Response

{
	"success": true,
	"status": "200 OK",
	"data": [
		{
			"id": 1,
			"policyName": "AdminAccess"
		},
		{
			"id": 2,
			"policyName": "UserAccess"
		}
	]
}

Create Policy POST /api/v1/policy

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

Request Body

{
	"policyName": "NewPolicy"
}

Example Request

curl -X 'POST' \
'https://um.braegen.ai/api/v1/policy' \
-H 'accept: */*' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{
    "policyName": "NewPolicy"
}'

Example Response

{
	"success": true,
	"status": "200 OK",
	"message": "Policy created successfully",
	"data": {
		"id": 3,
		"policyName": "NewPolicy"
	}
}

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}

Common Error Responses

Not Found Error

{
	"success": false,
	"status": "404 NOT_FOUND",
	"message": "Policy not found",
	"data": null
}

Validation Error

{
	"success": false,
	"status": "400 BAD_REQUEST",
	"message": "Invalid policy name",
	"data": null
}

Authorization Error

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

Previous

Authentication Management

Next

Policy Rule Management

On this page