Skip to content

Policy Management REST API (0.0.3)

Overview

The Policy Evaluation REST API's allow the evaluation of a policy with the provided criteria. A policy with attributes set, where the provided criteria is not provided will always fail. The text for matching criteria can be found in the policy criteria attributes in the policy management API.

Rate Limit

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

  • Limits are applied to each tenant.
  • A maximum of 40 calls can be made per second.
  • Each second 20 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/

Criteria Evaluation

Evaluates policy criteria provided and identifies the matching policy.

Operations

Evaluate Criteria

Request

Evaluates the criteria provided and returns the matched response from the first matching policy within the specified set, or it will indicate that no match was found. A policy has additional required criteria and no matching test criteria is provided, that will be considered a failure. Additional test attributes that are provided but are not required within a policy will be ignored and not considered a match failure.

Path
policySetIdstring(uuid)required
Body
required
evaluationCriteriaArray of objects(Evaluation Criteria)required

The complete list of criteria to evaluate against this policy set.

evaluationCriteria[].​matchNamestringrequired

The name of the attribute to match. This must be an exact match to the attribute text as defined in the policy template attribute defined in the policy.

evaluationCriteria[].​valueBoolean Evaluation (object) or Date Time Evaluation (object) or Number Evaluation (object) or String Evaluation (object)required
One of:

When requesting a policy set evaluation, this defined the boolean value to be used in evaluation.

evaluationCriteria[].​value.​booleanValuebooleanrequired

The boolean value to use for evaluation.

wasMatchedboolean

The overall results of the matched request. This will be ignored on the post if it is provided.

policyNamestring

The name of the specific policy that was matched. Ignored on the post, and will not be set if no match was made.

policyIdstring(uuid)

The unique identifier of the specific policy that was found during evaluation. It will be ignored on the post and will not be set if no matching policy was found.

policyTypestring

The type of policy that was found during evaluation. Optional, and will be used on the post if it is a valid policy type, and can be evaluated. UNMATCHED, DPSK and RADIUS map to the existing policy types, any other policy types are not available.

Enum"BASE""RADIUS""DPSK""UNMATCHED"
onMatchResponsestring

The response value that was defined in the policy that was matched.

identityGroupIdstring

Identity group identifier. If provided policy set associated to the identity group is evaluated prior to user provided policy set.

policySetIdstring(uuid)

The identifier for the policy set to evaluate.

_linksobject(Links)
{
  "evaluationCriteria": [
    { … }
  ],
  "wasMatched": true,
  "policyName": "string",
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  "policyType": "BASE",
  "onMatchResponse": "string",
  "identityGroupId": "string",
  "policySetId": "cd627cf7-03c4-4c1d-8b46-84b816ad5cc6",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Policy set was evaluated and results are returned.

Body
evaluationCriteriaArray of objects(Evaluation Criteria)required

The complete list of criteria to evaluate against this policy set.

evaluationCriteria[].​matchNamestringrequired

The name of the attribute to match. This must be an exact match to the attribute text as defined in the policy template attribute defined in the policy.

evaluationCriteria[].​valueBoolean Evaluation (object) or Date Time Evaluation (object) or Number Evaluation (object) or String Evaluation (object)required
One of:

When requesting a policy set evaluation, this defined the boolean value to be used in evaluation.

evaluationCriteria[].​value.​booleanValuebooleanrequired

The boolean value to use for evaluation.

wasMatchedboolean

The overall results of the matched request. This will be ignored on the post if it is provided.

policyNamestring

The name of the specific policy that was matched. Ignored on the post, and will not be set if no match was made.

policyIdstring(uuid)

The unique identifier of the specific policy that was found during evaluation. It will be ignored on the post and will not be set if no matching policy was found.

policyTypestring

The type of policy that was found during evaluation. Optional, and will be used on the post if it is a valid policy type, and can be evaluated. UNMATCHED, DPSK and RADIUS map to the existing policy types, any other policy types are not available.

Enum"BASE""RADIUS""DPSK""UNMATCHED"
onMatchResponsestring

The response value that was defined in the policy that was matched.

identityGroupIdstring

Identity group identifier. If provided policy set associated to the identity group is evaluated prior to user provided policy set.

policySetIdstring(uuid)

The identifier for the policy set to evaluate.

_linksobject(Links)
Response
{
  "evaluationCriteria": [
    { … }
  ],
  "wasMatched": true,
  "policyName": "string",
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b",
  "policyType": "BASE",
  "onMatchResponse": "string",
  "identityGroupId": "string",
  "policySetId": "cd627cf7-03c4-4c1d-8b46-84b816ad5cc6",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}