Identity Broker REST API Reference

UnboundID Logo

/templates

Mount Point: /auth/api/v1/templates/

GET

Retrieve a list of Policy Templates from the entire set of defined Policy Templates.

Parameters

name description type default
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 and NAME_DESCENDING. A null value returns items in an unspecified order. 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: persistedPolicyTemplate
media types: application/json

Paged results of all requested Policy Templates.

Status Codes

code description
200 Success

POST

Imports a policy template. If a template already exists with the same template Id, the template is updated, otherwise a new policy template is created.

Parameters

name description type default
name The friendly name for the policy template, or null if the template ID should be used as the friendly name. query

Request Body

element: Policy
media types: text/xml

XML content of policy template of type com.unboundid.broker.models.policy.XACMLPolicy

Response Body

result: persistedPolicyTemplate
media types: application/json

The policy template, as persisted.

Status Codes

code description
201 Success
400 Bad Request