Identity Broker REST API Reference

UnboundID Logo

/policies/{id}

This resource is available only to principals with these entitlements: "ROLE_READ_POLICY" "ROLE_BROKER_ADMIN"

Mount Point: /auth/api/v1/policies/{id}/

The following operations are supported on this resource:

GET

This operation is available only to principals with these entitlements: "ROLE_READ_POLICY" "ROLE_BROKER_ADMIN"

Retrieve a specified policy.

Parameters

name description type default
id Either a Xacml policy ID (URN) or the policy's dataStore Id path

Response Body

result: persistedPolicy
media types: application/json

The requested policy.

Status Codes

code description
200 Success
304 Not modified
404 No such object

PUT

This operation is available only to principals with these entitlements: "ROLE_UPDATE_POLICY" "ROLE_BROKER_ADMIN"

Update properties of the specified policy.

Parameters

name description type default
id Either a Xacml policy ID (URN) or the policy's dataStore Id path

Request Body

element: persistedPolicy
media types: application/json

contains new values for the policy. Any null values are ignored.

Response Body

result: persistedPolicy
media types: application/json

PersistedPolicy updated policy.

Status Codes

code description
200 Success
412 Precondition failed
409 Reserved for cache object out of date

DELETE

This operation is available only to principals with these entitlements: "ROLE_DELETE_POLICY" "ROLE_BROKER_ADMIN"

Deletes the specified policy.

Parameters

name description type default
id Either a Xacml policy ID (URN) or the policy's dataStore Id. path
force true to delete regardless of existing references to the policy, or false to fail if there are existing references. query

Status Codes

code description
204 Success
404 No such object