GEgetaxonflow
Dynamic Policies

Create policy

Create a new policy

post/api/v1/policies

Request

Headers

X-Tenant-IDstring required
X-User-IDstring

Request body

namestring required
descriptionstring
type'static' | 'dynamic' required
categorystring
tier'organization' | 'tenant'
patternstring

Required for static policies

action'block' | 'require_approval' | 'redact' | 'warn' | 'log'
severity'critical' | 'high' | 'medium' | 'low'
priorityinteger
enabledboolean
conditionsobject[]

Required for dynamic policies

actionsobject[]

Required for dynamic policies

Response

Policy created

idstring uuid
policy_idstring

Human-readable identifier

namestring
descriptionstring
type'static' | 'dynamic'
categorystring
tier'system' | 'organization' | 'tenant'
patternstring

Regex pattern (for static policies)

action'block' | 'require_approval' | 'redact' | 'warn' | 'log'
severity'critical' | 'high' | 'medium' | 'low'
priorityinteger
enabledboolean
conditionsobject[]

Conditions (for dynamic policies)

actionsobject[]

Actions (for dynamic policies)

versioninteger
tenant_idstring
organization_idstring

The organisation that owns this policy. This is the current wire field name and it is not deprecated: it is unrelated to a database column of the same name that was retired in an earlier release. The two share a name and nothing else.

created_bystring
created_atstring date-time
updated_bystring
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.