/policies
Mount Point: /auth/api/v1/policies/
GET
Retrieve a list of policies from the entire set of defined policies.
Parameters
| name |
description |
type |
default |
| includeXml |
Indicates whether the XACML for each policy should be included in the results. Specify true to include XACML for policies 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 |
|
| 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_ID_ASCENDING, POLICY_ID_DESCENDING, POLICY_ENABLED, and POLICY_DISABLED.
|
query |
NAME_ASCENDING |
| filterBy |
Specifies how filtering will occur. Allowed values are NAME_EQUALITY, NAME, DESCRIPTION, ID, VERSION.
|
query |
|
| filter |
user-supplied input used for filtering.
|
query |
|
| excludesList |
comma-separated list of ids to exclude from results.
|
query |
|
Response Body
Paged results of all requested policies.
Status Codes
| code |
description |
| 200 |
Success
|
POST
Imports the given policy. If a policy already exists with the same policy
Id, the policy is updated, otherwise a new policy is created.
Parameters
| name |
description |
type |
default |
| name |
The friendly name for the policy, or null if the policy ID should be used as the friendly name.
|
query |
|
| enabled |
whether the policy should be enabled, default is disabled
|
query |
false |
Request Body
| element: |
Policy |
| media types: |
text/xml |
XML content of policy of type com.unboundid.broker.models.policy.XACMLPolicy.
Response Body
The policy, as persisted.
Status Codes
| code |
description |
| 201 |
Success
|
| 400 |
Bad Request
|
