Skip to content
Overview/
/
Adaptive Policy Managemen...
/
Changed
Last updated

Adaptive Policy Management

GET /policySets
Parameters:
  • Changed: sort in query

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

POST /policySets
Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 409 Conflict

Invalid policy set details provided.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 201 Created

Policy set created

  • Changed content type : application/json
POST /policySets/query
Request:
  • Changed content type : application/json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

Return Type:
  • Changed response : 422 Unprocessable Entity

Some of the provided query data is invalid.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

DELETE /policySets/{policySetId}
Return Type:
  • Changed response : 200 OK

Policy set deleted

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Policy set not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 409 Conflict

The requested policy set is still in use.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

GET /policySets/{policySetId}
Return Type:
  • Changed response : 404 Not Found

Policy set not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 200 OK

Policy set found

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

PATCH /policySets/{policySetId}
Request:

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

Return Type:
  • Changed response : 409 Conflict

Invalid policy set details provided.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 200 OK

Policy set updated

  • Changed content type : application/json
GET /policySets/{policySetId}/assignments
Parameters:
  • Changed: sort in query

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

Return Type:
  • Changed response : 404 Not Found

Policy set not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 200 OK

Policy set assignments in a paged format.

  • Changed content type : application/json

    New required properties:

    • id
    • identityId
    • identityName

    • Added property id (object)

      The identifier for this assignment.

    • Added property identityId (object)

      The unique identifier for the identity that is assigned to this policy set.

    • Added property identityName (object)

      The identity name that is assigned to this policy set.

    • Deleted property content (object)

      The content list of the data.

    • Deleted property paging (object)

      Pagination metadata for query results including total count, current page, page size, and total pages

  • Changed content type : application/vnd.ruckus.v1+json

    New required properties:

    • id
    • identityId
    • identityName

    • Added property id (object)

      The identifier for this assignment.

    • Added property identityId (object)

      The unique identifier for the identity that is assigned to this policy set.

    • Added property identityName (object)

      The identity name that is assigned to this policy set.

    • Deleted property content (object)

      The content list of the data.

    • Deleted property paging (object)

      Pagination metadata for query results including total count, current page, page size, and total pages

POST /policySets/{policySetId}/assignments/query
Request:
  • Changed content type : application/json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

Return Type:
  • Changed response : 404 Not Found

Policy set not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 422 Unprocessable Entity

Some of the provided query data is invalid.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 200 OK

List Policy Set Assignments in a paged format.

  • Changed content type : application/json

    New required properties:

    • id
    • identityId
    • identityName

    • Added property id (object)

      The identifier for this assignment.

    • Added property identityId (object)

      The unique identifier for the identity that is assigned to this policy set.

    • Added property identityName (object)

      The identity name that is assigned to this policy set.

    • Deleted property content (object)

      The content list of the data.

    • Deleted property paging (object)

      Pagination metadata for query results including total count, current page, page size, and total pages

  • Changed content type : application/vnd.ruckus.v1+json

    New required properties:

    • id
    • identityId
    • identityName

    • Added property id (object)

      The identifier for this assignment.

    • Added property identityId (object)

      The unique identifier for the identity that is assigned to this policy set.

    • Added property identityName (object)

      The identity name that is assigned to this policy set.

    • Deleted property content (object)

      The content list of the data.

    • Deleted property paging (object)

      Pagination metadata for query results including total count, current page, page size, and total pages

GET /policySets/{policySetId}/assignments/{assignmentId}
Return Type:
  • Changed response : 404 Not Found

Policy set or assignment not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

GET /policySets/{policySetId}/prioritizedPolicies
Return Type:
  • Changed response : 404 Not Found

Policy set not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

DELETE /policySets/{policySetId}/prioritizedPolicies/{policyId}
Return Type:
  • Changed response : 200 OK

Policy removed from policy set successfully.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 204 No Content

Policy removed from policy set, no content.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Policy set or policy not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

GET /policySets/{policySetId}/prioritizedPolicies/{policyId}
Return Type:
  • Changed response : 404 Not Found

Policy set or policy not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

PUT /policySets/{policySetId}/prioritizedPolicies/{policyId}
Return Type:
  • Changed response : 409 Conflict

Invalid assignment details provided.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

GET /policyTemplates
Parameters:
  • Changed: sort in query

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

GET /policyTemplates/policies
Parameters:
  • Changed: sort in query

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

POST /policyTemplates/policies/query
Request:
  • Changed content type : application/json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

Return Type:
  • Changed response : 422 Unprocessable Entity

Some of the provided query data is invalid.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

POST /policyTemplates/query
Request:
  • Changed content type : application/json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

Return Type:
  • Changed response : 422 Unprocessable Entity

Some of the provided query data is invalid.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

GET /policyTemplates/{templateId}
Return Type:
  • Changed response : 404 Not Found

Policy template not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 200 OK

Policy template found

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

GET /policyTemplates/{templateId}/attributes
Parameters:
  • Changed: sort in query

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

Return Type:
  • Changed response : 404 Not Found

Template not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

POST /policyTemplates/{templateId}/attributes/query
Request:
  • Changed content type : application/json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

Return Type:
  • Changed response : 404 Not Found

Template not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 422 Unprocessable Entity

Some of the provided query data is invalid.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

GET /policyTemplates/{templateId}/attributes/{attributeId}
Return Type:
  • Changed response : 404 Not Found

Template or attribute not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

GET /policyTemplates/{templateId}/policies
Parameters:
  • Changed: sort in query

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

Return Type:
  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 404 Not Found

Not Found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

POST /policyTemplates/{templateId}/policies
Return Type:
  • Changed response : 409 Conflict

Invalid policy details provided.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

POST /policyTemplates/{templateId}/policies/query
Request:
  • Changed content type : application/json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property filters (object)

    The list of filters to apply.

  • Changed property sortOrder (object)

    The sort order of the applied query.

Return Type:
  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 404 Not Found

Not Found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 422 Unprocessable Entity

Some of the provided query data is invalid.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

DELETE /policyTemplates/{templateId}/policies/{policyId}
Return Type:
  • Changed response : 200 OK

Policy deleted

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Policy not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 409 Conflict

The requested policy is still in use in a policy set.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

GET /policyTemplates/{templateId}/policies/{policyId}
Return Type:
  • Changed response : 400 Bad Request

Invalid id supplied.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 404 Not Found

Policy Template not found.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

GET /policyTemplates/{templateId}/policies/{policyId}/conditions
Parameters:
  • Changed: sort in query

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

Return Type:
  • Changed response : 404 Not Found

Not Found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

POST /policyTemplates/{templateId}/policies/{policyId}/conditions
Request:
  • Changed content type : application/json
  • Changed property evaluationRule (object)

    Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property evaluationRule (object)

    Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

Return Type:
  • Changed response : 404 Not Found

Not Found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 409 Conflict

Condition type is already mapped.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 201 Created

Condition created

  • Changed content type : application/json

    • Changed property evaluationRule (object)

      Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property evaluationRule (object)

      Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

DELETE /policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}
Return Type:
  • Changed response : 200 OK

Condition deleted successfully.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 204 No Content

Condition deleted, no content.

  • Changed content type : application/json

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed response : 404 Not Found

Policy or template not found

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 409 Conflict

Policy will not have any conditions if this is deleted.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

GET /policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}
Return Type:
  • Changed response : 404 Not Found

Not Found.

  • Changed content type : application/json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      List of user friendly error messages with codes and suggestions.

  • Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property evaluationRule (object)

      Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property evaluationRule (object)

      Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

PATCH /policyTemplates/{templateId}/policies/{policyId}/conditions/{conditionId}
Request:
  • Changed content type : application/json
  • Changed property evaluationRule (object)

    Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

  • Changed content type : application/vnd.ruckus.v1+json
  • Changed property evaluationRule (object)

    Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

Return Type:
  • Changed response : 200 OK

Policy condition updated

  • Changed content type : application/json

    • Changed property evaluationRule (object)

      Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property evaluationRule (object)

      Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

  • Changed response : 409 Conflict

Invalid policy condition details provided.

  • Changed content type : application/json

    • Changed property evaluationRule (object)

      Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property evaluationRule (object)

      Base class for evaluation criteria used in policy conditions. Supports different types of criteria including boolean, number, string regex, and date range evaluations. The criteriaType property determines which criteria subclass is used (BooleanCriteria, NumberCriteria, StringCriteria, or DateRangeCriteria).

Previous page
Next page