Identity Broker REST API Reference

UnboundID Logo

/templates/{id}/policies

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

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

GET

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

Retrieve all policies that have been instantiated from a template.

Parameters

name description type default
id Either the template's Xacml policy ID (URN) or the template's dataStore Id. path
includeXml whether to include the XACML XML body in the response. 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
excludesList comma-separated list of ids to exclude from results. query

Response Body

result: persistedPolicy
media types: application/json

Paged results of all Policy instances

Status Codes

code description
200 Success