Identity Broker REST API Reference

UnboundID Logo

/templates/{templateId}/{policyId}

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

Mount Point: /auth/api/v1/templates/{templateId}/{policyId}/

PUT

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

Instantiate a policy template and overwrite an existing policy with the result. The existing policy must have been originally derived from the template.

Parameters

name description type default
templateId template to instantiate, identified by either the template's Xacml policy ID (URN) or the template's dataStore Id. path
policyId policy to overwrite, identified by either the policy's Xacml policy Id (URN) or the policy's dataStore Id. path
name "friendly name" for new policy query
description optional policy description query
enabled whether to immediately enable the new policy query false

Request Body

element: (custom)
media types: application/json

name-value pairs of template parameters

Response Body

result: persistedPolicy
media types: application/json

Response containing new PersistedPolicy object

Status Codes

code description
200 Success
400 Bad Request