Skip to content

Policy Management REST API (0.0.8)

Overview

The Policy Management REST API's and Model, allow the creation, delete and modification of policies, policy sets, and assigning policies to policy sets. All policies must be inherited from a policy template. Only those evaluation conditions that are defined for the template can be assigned to the policy. Once a policy is assigned to a policy set, it must be given an evaluation priority. If the priority is changed, or a policy added or removed, the priority of the other policies will be automatically re-ordered.

Rate Limit

For the Policy Management REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 100 calls can be made per second.
  • Each second 50 calls will be returned to be used.
Download OpenAPI description
Languages
Servers
Generated server url

http://localhost:8080/

Policy Conditions

Manage the conditions that are applied on the specified policy.

Operations

Policy Templates

View the list of policy templates.

Operations

Policy Set Prioritized Rules

Manages, create and gets the policies prioritized for this set.

Operations

Get Prioritized Policy

Request

Retrieves the requested policy priority.

Path
policySetIdstring(uuid)required

Policy set identifier.

policyIdstring(uuid)required

Policy identifier.

No request payload

Responses

Success

Body
policyIdstring(uuid)

The identifier for the prioritized policy. Will be ignored on a put, as URL is the identifier.

priorityinteger(int32)

The priority of this policy, 1 being the highest priority.

_linksobject(Links)
Response
{ "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b", "priority": 0, "_links": { "property1": {}, "property2": {} } }

Assign Policy Priority

Request

Maps policy to the priority defined on this set, will order the other priorities.

Path
policySetIdstring(uuid)required

Policy set identifier.

policyIdstring(uuid)required

Policy identifier.

Bodyrequired
policyIdstring(uuid)

The identifier for the prioritized policy. Will be ignored on a put, as URL is the identifier.

priorityinteger(int32)

The priority of this policy, 1 being the highest priority.

_linksobject(Links)
{ "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b", "priority": 0, "_links": { "property1": {}, "property2": {} } }

Responses

Success

Body
policyIdstring(uuid)

The identifier for the prioritized policy. Will be ignored on a put, as URL is the identifier.

priorityinteger(int32)

The priority of this policy, 1 being the highest priority.

_linksobject(Links)
Response
{ "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b", "priority": 0, "_links": { "property1": {}, "property2": {} } }

Remove Policy Assignment

Request

Removes the priority mapping assignment of the policy to this policy set.

Path
policySetIdstring(uuid)required

Policy set identifier.

policyIdstring(uuid)required

Policy identifier.

No request payload

Responses

Policy priority assignment removed

Body
object
Response
{}

Get Prioritized Policies

Request

Gets the list of prioritized policies for this policy set.

Path
policySetIdstring(uuid)required

Policy set identifier.

No request payload

Responses

Prioritized policies.

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(Prioritized Policy)

The content list of the data.

_linksobject(Links)
Response
{ "paging": { "totalCount": 0, "page": 0, "pageSize": 0, "pageCount": 0 }, "content": [ {} ], "_links": { "property1": {}, "property2": {} } }

Policies

Manages, create and get of policies assigned to a specific template.

Operations

Policy Sets

Manages the policy sets.

Operations

Policy Set Assignments

Provides information on the assignments made on a policy set.

Operations