Skip to content
/
Get Policy Set Assignment...

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

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

Query Policy Set Assignments

Request

Returns the list of assignments 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

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 set assignments in a paged format. Can exclude content for just count information

Body
pagingobject(PageDto)

The paging information for this response.

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 this 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 Assignments.

Body
pagingobject(PageDto)

The paging information for this response.

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 assignment for the policy set.

Path
policySetIdstring(uuid)required

Policy set identifier.

assignmentIdstring(uuid)required

Assignment identifier.

No request payload

Responses

Success

Body
idstring(uuid)required

The identifier for this assignment.

identityIdstringrequired

The id of 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": { … }
  }
}