Adaptive Policy Management (0.0.10)

Overview

The Adaptive Policy Management REST APIs and Model, allow the creation, deletion, 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 reordered.

What This API Does

Create, modify, and delete policies
Manage policy sets and assignments
Configure policy templates and evaluation conditions
Set and manage policy priorities

Authentication

All API calls require valid authentication via Bearer token in Authorization header.

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

All endpoints may return these common error responses:

400 Bad Request: Invalid input data or validation errors
401 Unauthorized: Missing or invalid authentication
403 Forbidden: Insufficient permissions
404 Not Found: Requested resource doesn't exist
409 Conflict: Resource conflict (e.g., duplicate names)
422 Unprocessable Entity: Business rule violations
500 Internal Server Error: Unexpected server errors

Download OpenAPI description

Download PDF

Overview

License

RUCKUS Cloud Privacy Policy

Servers

RUCKUS One API host for North American region.

https://api.ruckus.cloud

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud

Policy Conditions

Manage the conditions that are applied on the specified policy.

Operations

Get Conditions

Request

Retrieves the list of conditions 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 separated from the sort order (asc or desc).

No request payload

Responses

Success

Body

pagingobject(Page Data)

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)

The complete template attribute to associate with this condition. This is provided when getting the resource only, and will not be evaluated on POST or PATCH.

evaluationRuleobject(Evaluation Criteria)

One of:

The evaluation criteria for this condition. Must match the attribute type selected.

object Recursive

_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",
    "category": "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)

The complete template attribute to associate with this condition. This is provided when getting the resource only, and will not be evaluated on POST or PATCH.

evaluationRuleobject(Evaluation Criteria)

One of:

The evaluation criteria for this condition. Must match the attribute type selected.

object Recursive

_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",
    "category": "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)

The complete template attribute to associate with this condition. This is provided when getting the resource only, and will not be evaluated on POST or PATCH.

evaluationRuleobject(Evaluation Criteria)

One of:

The evaluation criteria for this condition. Must match the attribute type selected.

object Recursive

_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",
    "category": "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

Policy Template identifier.

policyIdstring(uuid)required

Policy identifier.

conditionIdstring(uuid)required

Condition identifier.

No request payload

Responses

Condition deleted successfully.

Body

object(EmptyResponse)

Empty response for successful deletion operations.

Response

{}

Update Policy Condition

Request

Updates the policy condition from the requested values.

Path

templateIdinteger(int64)required

policyIdstring(uuid)required

conditionIdstring(uuid)required

Body

required

templateAttributeIdinteger(int64)

The complete template attribute to associate with this condition.

evaluationRuleobject(Evaluation Criteria)

One of:

The evaluation criteria for this condition. Must match the attribute type selected.

object Recursive

{
  "templateAttributeId": 0,
  "evaluationRule": {
    "criteriaType": "string",
    "booleanCriteria": true
  }
}

Responses

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

The complete template attribute to associate with this condition. This is provided when getting the resource only, and will not be evaluated on POST or PATCH.

evaluationRuleobject(Evaluation Criteria)

One of:

The evaluation criteria for this condition. Must match the attribute type selected.

object Recursive

_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",
    "category": "string",
    "_links": { … }
  },
  "evaluationRule": {
    "criteriaType": "string",
    "booleanCriteria": true
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Policies

Manages the creation and retrieval of policies assigned to a specific template.

Operations

Policy Set Assignments

Manage the assignments of policy sets to identities.

Operations

Policy Templates

View the list of policy templates.

Operations

Prioritized Policies

Manage the prioritized policies within a policy set.

Operations

Policy Sets

Manages the policy sets.

Operations

Adaptive Policy Management (0.0.10)

Overview

What This API Does

Authentication

Error Handling

Common Error Responses

Policy Conditions

Get Conditions

Request

Responses

Create Condition

RequestExpand all

Responses

Get Condition

Request

Responses

Delete Conditions

Request

Responses

Update Policy Condition

RequestExpand all

Responses

Policies

Policy Set Assignments

Policy Templates

Prioritized Policies

Policy Sets

Request

Request