/policysets

Mount Point: /auth/api/v1/policysets/

GET

Retrieve a list of policy sets from the entire set of defined policy sets.

Parameters

name	description	type	default
includeXml	Indicates whether the XACML for each policy set should be included in the results. Specify true to include XACML for policy sets or false otherwise.	query	false
startIndex	The index number of the first item to be provided in the results. A null value is equivalent to 0.	query	0
count	The maximum number of items to be provided in the results. A null value signifies no maximum.	query
sortBy	Specifies how the results should be sorted. Allowed values are NAME_ASCENDING, NAME_DESCENDING, POLICY_SET_ID_ASCENDING, POLICY_SET_ID_DESCENDING, POLICY_SET_ENABLED, POLICY_SET_DISABLED.	query	NAME_ASCENDING
filterBy	Specifies how filtering will occur. Allowed values are NAME_EQUALITY, NAME, DESCRIPTION, ID and VERSION.	query
filter	user-supplied input used for filtering.	query
excludesList	comma-separated list of ids to exclude from results.	query

Response Body

result:	persistedPolicySet
media types:	application/json

Paged results of all requested policy sets.

Status Codes

code	description
200	Success

POST

Imports the given policy set. If a policy set already exists with the same policy set ID, the policy set is updated, otherwise a new policy set is created.

Parameters

name	description	type	default
name	optional friendly name for policy set	query
enabled	whether the policy set should be enabled, default is disabled	query	false

Request Body

element:	PolicySet
media types:	text/xml

XML content of policy set of type com.unboundid.broker.models.policy.XACMLPolicySet.

Response Body

result:	persistedPolicySet
media types:	application/json

The policy set, as persisted.

Status Codes

code	description
201	Success
400	Bad Request