/policies
This resource is available only to principals with these entitlements: "ROLE_READ_POLICY" "ROLE_BROKER_ADMIN"
Mount Point: /auth/api/v1/policies/
GET
This operation is available only to principals with these entitlements: "ROLE_READ_POLICY" "ROLE_BROKER_ADMIN"
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 defined by com.unboundid.policy.models.PersistedPolicy#getSortsByEnumValues(). A null value returns items in an unspecified order. | query | NAME_ASCENDING |
| filterBy | Specifies how filtering will occur. Allowed values are defined in com.unboundid.policy.models.PersistedPolicy#getFiltersByEnumValues() . | query | |
| filter | user-supplied input used for filtering. | query | |
| excludesList | comma-separated list of ids to exclude from results. | query |
Response Body
| result: | persistedPolicy |
| media types: | application/json |
Paged results of all requested policies.
Status Codes
| code | description |
|---|---|
| 200 | Success |
POST
This operation is available only to principals with these entitlements: "ROLE_CREATE_POLICY" "ROLE_BROKER_ADMIN"
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: | (custom) |
| media types: | text/xml |
XML content of policy of type com.unboundid.policy.models.xacml.PolicyType.
Response Body
| result: | persistedPolicy |
| media types: | application/json |
The policy, as persisted.
Status Codes
| code | description |
|---|---|
| 201 | Success |
| 400 | Bad Request |