Skip to content
/
Delete Conditions

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
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Generated server url

http://localhost:8080/

Policy Conditions

Manage the conditions that are applied on the specified policy.

Operations

Get Conditions

Request

Retrieves the list of condition for the policy.

Path
templateIdinteger(int64)required

Template identifier.

policyIdstring(uuid)required

Policy identifier.

Query
sizeany

Page size

pageany

The page to retrieve (starts at zero).

sortany

The field name to sort, comma seperated from the sort order (asc or desc).

No request payload

Responses

Success

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(Policy Condition)

The content list of the data.

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

Create Condition

Request

Creates a condition and applies it to the policy.

Path
templateIdinteger(int64)required

Policy Template identifier.

policyIdstring(uuid)required

Policy identifier.

Body
required
idstring(uuid)

The identifier for this policy condition.

policyIdstring(uuid)required

The identifier of the policy to assign this condition.

templateAttributeIdinteger(int64)required

The identifier for the template attribute to associate with this condition.

templateAttributeobject(Dynamic Policy Template Attribute)

Attribute that is allowed to be assigned on a policy using the template.

evaluationRuleobject(EvaluationCriteria)
_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  "templateAttributeId": 0,
  "templateAttribute": {
    "id": 0,
    "name": "string",
    "description": "string",
    "attributeTextMatch": "string",
    "attributeType": "STRING",
    "_links": { … }
  },
  "evaluationRule": {
    "criteriaType": "string",
    "booleanCriteria": true
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Condition created

Body
idstring(uuid)

The identifier for this policy condition.

policyIdstring(uuid)required

The identifier of the policy to assign this condition.

templateAttributeIdinteger(int64)required

The identifier for the template attribute to associate with this condition.

templateAttributeobject(Dynamic Policy Template Attribute)

Attribute that is allowed to be assigned on a policy using the template.

evaluationRuleobject(EvaluationCriteria)
_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  "templateAttributeId": 0,
  "templateAttribute": {
    "id": 0,
    "name": "string",
    "description": "string",
    "attributeTextMatch": "string",
    "attributeType": "STRING",
    "_links": { … }
  },
  "evaluationRule": {
    "criteriaType": "string",
    "booleanCriteria": true
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get Condition

Request

Retrieves the requested condition for the policy.

Path
templateIdinteger(int64)required

Template identifier.

policyIdstring(uuid)required

Policy identifier.

conditionIdstring(uuid)required

Condition identifier.

No request payload

Responses

Success

Body
idstring(uuid)

The identifier for this policy condition.

policyIdstring(uuid)required

The identifier of the policy to assign this condition.

templateAttributeIdinteger(int64)required

The identifier for the template attribute to associate with this condition.

templateAttributeobject(Dynamic Policy Template Attribute)

Attribute that is allowed to be assigned on a policy using the template.

evaluationRuleobject(EvaluationCriteria)
_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  "templateAttributeId": 0,
  "templateAttribute": {
    "id": 0,
    "name": "string",
    "description": "string",
    "attributeTextMatch": "string",
    "attributeType": "STRING",
    "_links": { … }
  },
  "evaluationRule": {
    "criteriaType": "string",
    "booleanCriteria": true
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete Conditions

Request

Deletes the condition from the specified policy, but only if at least one condition still exists.

Path
templateIdinteger(int64)required

Template identifier

policyIdstring(uuid)required

Policy identifier

conditionIdstring(uuid)required

Condition identifier

No request payload

Responses

Condition deleted

Body
object
Response
{}

Update Condition

Request

Updates the condition from the requested values.

Path
templateIdinteger(int64)required

Policy Template identifier.

policyIdstring(uuid)required

Policy identifier.

conditionIdstring(uuid)required

Condition identifier.

Body
required
idstring(uuid)

The identifier for this policy condition.

policyIdstring(uuid)required

The identifier of the policy to assign this condition.

templateAttributeIdinteger(int64)required

The identifier for the template attribute to associate with this condition.

templateAttributeobject(Dynamic Policy Template Attribute)

Attribute that is allowed to be assigned on a policy using the template.

evaluationRuleobject(EvaluationCriteria)
_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  "templateAttributeId": 0,
  "templateAttribute": {
    "id": 0,
    "name": "string",
    "description": "string",
    "attributeTextMatch": "string",
    "attributeType": "STRING",
    "_links": { … }
  },
  "evaluationRule": {
    "criteriaType": "string",
    "booleanCriteria": true
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Condition updated

Body
idstring(uuid)

The identifier for this policy condition.

policyIdstring(uuid)required

The identifier of the policy to assign this condition.

templateAttributeIdinteger(int64)required

The identifier for the template attribute to associate with this condition.

templateAttributeobject(Dynamic Policy Template Attribute)

Attribute that is allowed to be assigned on a policy using the template.

evaluationRuleobject(EvaluationCriteria)
_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  "templateAttributeId": 0,
  "templateAttribute": {
    "id": 0,
    "name": "string",
    "description": "string",
    "attributeTextMatch": "string",
    "attributeType": "STRING",
    "_links": { … }
  },
  "evaluationRule": {
    "criteriaType": "string",
    "booleanCriteria": true
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Policy Templates

View the list of policy templates.

Operations

Policy Set Prioritized Rules

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

Operations

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