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
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

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

Create Policy Set

Request

Creates a policy set from the requested values.

Body
required
idstring(uuid)

The identifier for this dynamic policy.

namestringrequired

The policy set name.

descriptionstringrequired

The policy set description.

mappedPolicyCountinteger(int64)

The number of policies mapped to this policy set.

assignmentCountinteger(int64)

The number of assignments to this policy set.

policyNamesArray of strings

The names of the policies mapped to this policy set.

externalAssignmentsArray of objects(Policy Set Assignment Groups)

The list of external assignments assigned to this policy set.

_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "mappedPolicyCount": 0,
  "assignmentCount": 0,
  "policyNames": [
    "string"
  ],
  "externalAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Created

Bodyapplication/json
idstring(uuid)

The identifier for this dynamic policy.

namestringrequired

The policy set name.

descriptionstringrequired

The policy set description.

mappedPolicyCountinteger(int64)

The number of policies mapped to this policy set.

assignmentCountinteger(int64)

The number of assignments to this policy set.

policyNamesArray of strings

The names of the policies mapped to this policy set.

externalAssignmentsArray of objects(Policy Set Assignment Groups)

The list of external assignments assigned to this policy set.

_linksobject(Links)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "mappedPolicyCount": 0,
  "assignmentCount": 0,
  "policyNames": [
    "string"
  ],
  "externalAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Query Policy Sets

Request

Returns the list of policies sets using the specified query.

Query
excludeContentboolean

Indicates that the content should be excluded from the query and only count and size data returned.

Default false
Body
required
sortFieldstring

The field to use to sort on.

sortOrderstring

The sort order of the applied query.

Enum"ASC""DESC"
pageinteger(int32)>= 0

The page number to return, paging starts with 0.

pageSizeinteger(int32)[ 1 .. 2000 ]

The number of items requested on the page.

filtersobject

The list of filters to apply.

{
  "sortField": "string",
  "sortOrder": "ASC",
  "page": 0,
  "pageSize": 1,
  "filters": {
    "property1": {},
    "property2": {}
  }
}

Responses

List policy sets in a paged format. Can exclude content for just count information

Bodyapplication/json
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(Policy Set)

The content list of the data.

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

Get Policy Set

Request

Retrieves the requested policy set.

Path
policySetIdstring(uuid)required

Policy set identifier.

No request payload

Responses

Success

Bodyapplication/json
idstring(uuid)

The identifier for this dynamic policy.

namestringrequired

The name of the policy.

descriptionstring

The policy description.

policyTypestringrequired

The data type for this attribute text. EX: it identifies which type of value the test data will be. This cannot be changed, and will be matched with the policy template for this policy type. It cannot be changed.

Enum"RADIUS""DPSK"
onMatchResponsestring

The response details if the policy is matched. For policy types which are RADIUS and DPSK, this is expected to be the identifier of a valid RADIUS attribute group.

policySetCountinteger(int64)

The number of policy sets that this policy is assigned to.

conditionsCountinteger(int64)

The number of conditions that are used when evaluating this policy.

policySetNamesArray of strings

The names of the policy sets that this policy is currently assigned to.

_linksobject(Links)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "policyType": "RADIUS",
  "onMatchResponse": "string",
  "policySetCount": 0,
  "conditionsCount": 0,
  "policySetNames": [
    "string"
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete Policy Set

Request

Deletes the policy set, but only if it is not used by another service.

Path
policySetIdstring(uuid)required

Policy Set identifier.

No request payload

Responses

Policy set deleted

Bodyapplication/json
object
Response
application/json
{}

Update Policy Set

Request

Updates the policy sets with the requested values. Only policy sets attributes can be changed. Use the prioritized policy APIs to manipulate the prioritized policies.

Path
policySetIdstring(uuid)required

Policy set identifier.

Body
required
idstring(uuid)

The identifier for this dynamic policy.

namestringrequired

The policy set name.

descriptionstringrequired

The policy set description.

mappedPolicyCountinteger(int64)

The number of policies mapped to this policy set.

assignmentCountinteger(int64)

The number of assignments to this policy set.

policyNamesArray of strings

The names of the policies mapped to this policy set.

externalAssignmentsArray of objects(Policy Set Assignment Groups)

The list of external assignments assigned to this policy set.

_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "mappedPolicyCount": 0,
  "assignmentCount": 0,
  "policyNames": [
    "string"
  ],
  "externalAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Policy set updated

Bodyapplication/json
object
Response
application/json
{}

Policy Set Assignments

Provides information on the assignments made on a policy set.

Operations