Add Action to Policy Configuration
Add a new action to an existing policy's configuration to define automated responses
Endpoint
POST /api/private/lifecycle_management/policies/{policy_id}/versions/{version_number}:add_actionDescription
Add a new action to an existing policy's configuration. Actions define what operations the policy performs when all conditions are met. Multiple actions can be executed in sequence or parallel depending on the action type and dependencies.
API Reference
OK
Default error response
POST /api/private/lifecycle_management/policies/{policy_id}/versions/{version_number}:add_action HTTP/1.1
Host: your-tenant.cookiecloud.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 612
{
"policy_id": "text",
"version_number": 1,
"workflow": "text",
"condition": "text",
"action": {
"name": "text",
"description": "text",
"type": 1,
"config": {
"@type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"conditions_on_success": [
{
"condition_type": 1,
"condition_string": "text",
"actions_to_run": [
{
"name": "text",
"type": 1
}
],
"name": "text",
"continue_actions_if_any_error": true,
"state": 1
}
],
"action_notification_settings": [
{
"notification_settings": {
"notification_type": 1,
"notification_id": "text",
"type_settings": {
"@type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"on_success": true,
"on_failure": true
}
],
"state": 1,
"run_once": true
}
}{
"value": {
"policy_id": "text",
"version_number": 1,
"state": 1,
"config": {
"workflows": [
{
"trigger_type": 1,
"description": "text",
"trigger_string": "text",
"conditions_on_success": [
{
"condition_type": 1,
"condition_string": "text",
"actions_to_run": [
{
"name": "text",
"type": 1
}
],
"name": "text",
"continue_actions_if_any_error": true,
"state": 1
}
],
"continuous_sync": true,
"name": "text",
"state": 1,
"attribute_to_get_execute_date": "text",
"local_time_zone_diff_from_utc": 1,
"local_time_zone_attribute": "text",
"trigger_at_local_time_hour": 1,
"execute_date_time_formatters": [
{
"date_formatter": "text",
"pipeline_functions": "text"
}
],
"grace_period_in_sec": 1,
"skip_trigger_recheck_after_grace_period": true,
"priority": 1
}
],
"actions": [
{
"name": "text",
"description": "text",
"type": 1,
"config": {
"@type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"conditions_on_success": [
{
"condition_type": 1,
"condition_string": "text",
"actions_to_run": [
{
"name": "text",
"type": 1
}
],
"name": "text",
"continue_actions_if_any_error": true,
"state": 1
}
],
"action_notification_settings": [
{
"notification_settings": {
"notification_type": 1,
"notification_id": "text",
"type_settings": {
"@type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"on_success": true,
"on_failure": true
}
],
"state": 1,
"run_once": true
}
],
"attribute_common_transformers": [
{
"name": "text",
"description": "text",
"entity_type": "text",
"entity_attribute_transformers": [
{
"destination_attribute": "text",
"destination_value_formatter": "text",
"continuous_sync": true,
"additional_value_formatter": [
"text"
],
"pipeline_functions": "text",
"unique_identifier": true
}
]
}
],
"lookup_table_references": [
{
"name": "text",
"description": "text",
"column_names": [
"text"
],
"lookup_table_id": "text"
}
],
"mover_properties": [
"text"
],
"password_complexity_rules": [
{
"name": "text",
"length": 1,
"use_special_characters": true,
"use_numbers": true,
"use_uppercase": true,
"use_lowercase": true,
"disallowed_characters": "text"
}
],
"transformer_functions": [
{
"function_expression": "text",
"definition": {
"name": "text",
"description": "text",
"parameters": [
{
"name": "text",
"description": "text",
"type": 1,
"allow_empty": true,
"optional": true,
"valid_values": [
"text"
]
}
],
"require_no_input": true,
"return_multiple_values": true,
"input_is_optional": true
}
}
]
},
"config_version": "text",
"created_by": "text",
"created_at": "2025-09-16T18:31:19.109Z",
"updated_at": "2025-09-16T18:31:19.109Z",
"published_by": "text",
"published_at": "2025-09-16T18:31:19.109Z"
}
}Request Examples
Path Parameters
policy_id
string
Yes
Unique identifier of the policy
version_number
integer
Yes
Version number of the policy version to modify
Request Body
workflow
string
Yes
Name of the workflow to add the action to
condition
string
Yes
Name of the condition within the workflow to add the action to
action
object
Yes
Action object to add
Action Object Fields
name
string
Yes
Name of the action
description
string
No
Description of the action
type
string
Yes
Action type (see ActionType enum values)
config
object
Yes
Configuration specific to the action type
conditions_on_success
array[object]
No
Conditions to run after successful action execution
action_notification_settings
array[object]
No
Notification settings for this action
state
string
No
Action state: ENABLED, DISABLED
run_once
boolean
No
Whether this action should only run once per identity
Response Examples
Action Configuration
Actions in Veza Lifecycle Management support various operation types. The config field contains action-specific configuration parameters that vary based on the action type. Common action types include:
SYNC_IDENTITIES - Synchronize identity information
MANAGE_RELATIONSHIPS - Manage identity relationships
CREATE_EMAIL - Send email notifications
DEPROVISION_IDENTITY - Remove or deactivate identities
WRITE_BACK_EMAIL - Write back email information
PAUSE - Pause workflow execution
SEND_NOTIFICATION - Send various types of notifications
CUSTOM_ACTION - Execute custom action logic
CREATE_ACCESS_REVIEW - Initiate access review workflows
Each action type requires specific configuration parameters in the config field.
Last updated
Was this helpful?