Overview#
Create a new policy from a template with custom configuration. Newly registered policies are inactive by default and must be explicitly activated.Register Policy#
Endpoint: POST /policy/registerContent-Type: application/jsonRequest Parameters#
| Parameter | Type | Required | Description |
|---|
name | string | No | Human-readable name for the policy |
policyTemplateId | string | Yes | Template identifier from list policy templates |
applyingEventIds | array[string] | Yes | Event identifiers that trigger this policy |
configuration | object | No | Custom configuration parameters for the policy |
configurationId | string | No | Voting configuration identifier to apply when policy triggers |
Use Case#
Use this endpoint to create a new policy based on a template. The registration process:1.
Select a template using policyTemplateId from the templates list
2.
Define which events trigger the policy using applyingEventIds
3.
Optionally customize policy behavior using configuration object
4.
Optionally specify a voting configuration using configurationId
Policy Registration Flow:Policy is created in inactive state
Configuration is validated against template requirements
Policy can be activated when ready using the activate policy endpoint
Event IDs specify which operations the policy evaluates. For example:Data token exchange events
Account modification events
Device registration events
The configuration object allows customization of template parameters such as:Security classification filters
Newly registered policies are inactive by default
Use list policy templates to get valid policyTemplateId values
Event IDs determine which operations trigger the policy
Configuration parameters depend on the selected template
Specify configurationId to link a voting configuration for authorization workflows
Activate the policy after registration to begin enforcement
Use descriptive names to identify policy purpose