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

Get Policy Template Attributes

Request

Gets the attributes associated with the specific policy template requested using a query.

Path
templateIdinteger(int64)required

Policy Template identifier.

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

Policy Template Attributes success

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(Dynamic Policy Template Attribute)

The content list of the data.

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

Query Policy Templates

Request

Gets the list of policy templates 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 Templates in a paged format.

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(Dynamic Policy Template)

The content list of the data.

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

All Policies by Query

Request

Returns the list of policies regardless of the template filtered by query criteria.

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

Policies in a paged format.

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(Policy)

The content list of the data.

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

Get Policy Templates

Request

Gets the list of policy templates in a paged format.

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

Policy Templates in a paged format.

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(Dynamic Policy Template)

The content list of the data.

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

Get Policy Template

Request

Gets the specific policy template requested.

Path
templateIdinteger(int64)required

Policy template identifier

No request payload

Responses

Policy Template success

Body
idinteger(int64)required

The identifier for this dynamic policy template.

namestringrequired

The policy template name.

descriptionstring

The policy template description.

returnTypestringrequired

The allowed return type for this dynamic policy template.

Value"RADIUS_ATTRIB_GROUP"
ruleTypestringrequired

The allowed rule type for this dynamic policy template.

Enum"RADIUS""DPSK"
_linksobject(Links)
Response
{
  "id": 0,
  "name": "string",
  "description": "string",
  "returnType": "RADIUS_ATTRIB_GROUP",
  "ruleType": "RADIUS",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get Policy Template Attributes

Request

Gets the attributes associated with the specific policy template requested.

Path
templateIdinteger(int64)required

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

Policy Template Attributes success

Body
pagingobject(PageDto)

The paging information for this response.

contentArray of objects(Dynamic Policy Template Attribute)

The content list of the data.

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

Get Policy Template Attribute

Request

Gets the requested attribute associated with the specific policy.

Path
templateIdinteger(int64)required

Policy Template identifier.

attributeIdinteger(int64)required

Policy Template Attribute identifier.

No request payload

Responses

Policy Template Attribute

Body
idinteger(int64)required

The identifier for this dynamic policy template attribute.

namestringrequired

The policy attribute name.

descriptionstring

The description for this policy template.

attributeTextMatchstring

The attribute value that is use match the value provided in the policy.

attributeTypestringrequired

The data type for this attribute text. EX: it identifies which type of value the test data will be.

Enum"STRING""NUMBER""BOOLEAN""DATE_RANGE"
_linksobject(Links)
Response
{
  "id": 0,
  "name": "string",
  "description": "string",
  "attributeTextMatch": "string",
  "attributeType": "STRING",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

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