Skip to content

Adaptive Policy Management (0.0.9)

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 re-ordered.

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

Languages
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

Policy Set Assignments

Manage the assignments of policy sets to identities.

Operations

Query Policy Set Assignments

Request

Returns the list of assignments for the specified policy set using the specified query.

Path
policySetIdstring(uuid)required

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

Defines the sort direction for query results.

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 Set Assignments in a paged format.

Body
pagingobject(Page Data)

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

contentArray of objects(Policy Set Assignment)

The content list of the data.

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

Get Policy Set Assignments

Request

Gets the list of assignments for the specified policy set.

Path
policySetIdstring(uuid)required

Policy set 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 set assignments in a paged format.

Body
pagingobject(Page Data)

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

contentArray of objects(Policy Set Assignment)

The content list of the data.

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

Get Policy Set Assignment

Request

Retrieves the requested policy set assignment.

Path
policySetIdstring(uuid)required

Policy set identifier.

assignmentIdstring(uuid)required

Assignment identifier.

No request payload

Responses

Policy set assignment found

Body
idstring(uuid)required

The identifier for this assignment.

identityIdstringrequired

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

identityNamestringrequired

The identity name that is assigned to this policy set.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "identityId": "string",
  "identityName": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Policy Templates

View the list of policy templates.

Operations

Policies

Manages, create and get of policies assigned to a specific template.

Operations

Prioritized Policies

Manage the prioritized policies within a policy set.

Operations

Policy Sets

Manages the policy sets.

Operations