Create Policy

Create a new policy for identity lifecycle management with conditions and actions

Endpoint

POST /api/private/lifecycle_management/policies

Description

Create a new policy in your Veza Lifecycle Management configuration. Policies define the main object for controlling Lifecycle Management operations and include descriptions. Each policy has multiple versions, one of which is live and up to one of which is in draft mode, with all others being historical.

Use this endpoint to:

• Create new lifecycle management policies

• Define data source connections for identity management

• Configure notification settings for policy events

• Set up safety limits and retry behavior

Prerequisites: Before creating policies, ensure you have identified your Source of Identity (SOI) datasources using the List Lifecycle Management Datasources endpoint.

Important: Policy vs Version States

There are two different state systems in the Lifecycle Management API:

• Policy States: Control the overall policy execution (INITIAL, RUNNING, PAUSED, DRY_RUN, PENDING)

• Version States: Control individual policy version status (DRAFT, PUBLISHED, RETIRED)

When creating a policy with this endpoint, use Policy States. Each policy can have multiple versions, each with their own version state.

API Reference

post

Authorizations

bearerAuth

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Body

application/json

namestringOptional

descriptionstringOptional

stateinteger · enumOptional

datasource_idsstring[]Optional

The source of truth data source(s) for this policy (must have one and must be of the same type)

sync_only_when_source_changesbooleanOptional

If true will only sync if the source of identity changes

time_before_sync_if_no_source_changes_in_minutesinteger · int32Optional

If sync_only_when_source_changes is true, how quickly (in minutes) to run a check when no changes are detected (default is 1 day 1440)

no_retry_for_failed_workflowbooleanOptional

if true will not retry failed workflows

max_retries_for_failed_workflowinteger · int32Optional

how many times we will retry a failed workflow (default is 10)

skip_workflow_runs_on_extractionbooleanOptional

if true, the workflow runs will be skipped for the extractions related to this Primary SOI

Responses

200

OK

application/json

default

Default error response

application/json

post

/api/private/lifecycle_management/policies

HTTPcURLJavaScriptPython

POST /api/private/lifecycle_management/policies HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1514

{
  "name": "text",
  "description": "text",
  "state": 1,
  "datasource_ids": [
    "text"
  ],
  "event_notification_settings": [
    {
      "event_type": 1,
      "notification_settings": {
        "notification_type": 1,
        "notification_id": "text",
        "email_settings": {
          "emails": [
            "text"
          ],
          "extra_email_fields": [
            "text"
          ],
          "email_formatters": [
            {
              "formatter": "text",
              "pipeline_functions": "text"
            }
          ]
        },
        "webhook_settings": {
          "webhook_url": "text",
          "webhook_auth_header": "text",
          "webhook_method": "text",
          "webhook_headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "on_success": true,
      "on_failure": true,
      "on_success_custom_template_id": "text",
      "on_failure_custom_template_id": "text"
    }
  ],
  "secondary_source_of_identities": [
    {
      "datasource_ids": [
        "text"
      ],
      "correlation_attribute_names": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "only_enrich_existing": true,
      "skip_workflow_runs_on_extraction": true
    }
  ],
  "sync_only_when_source_changes": true,
  "time_before_sync_if_no_source_changes_in_minutes": 1,
  "identity_attribute_mappings": [
    {
      "identity_attribute": 1,
      "entity_attribute_name": "text"
    }
  ],
  "safety_limit_settings": {
    "enable_change_limit": true,
    "enable_predictive_change_limit": true,
    "max_identities_affected_percentage": 1,
    "max_identities_affected_count": "text",
    "warning_email_addresses": [
      "text"
    ],
    "max_workflow_runs_percentage": 1,
    "max_workflow_runs_count": "text"
  },
  "no_retry_for_failed_workflow": true,
  "max_retries_for_failed_workflow": 1,
  "skip_workflow_runs_on_extraction": true,
  "valid_identity_settings": {
    "enabled": true,
    "valid_identity_filter": "text",
    "invalid_identity_filter": "text",
    "max_invalid_events": 1,
    "max_invalid_allowed_to_proceed": 1
  }
}

{
  "value": {
    "id": "text",
    "name": "text",
    "description": "text",
    "state": 1,
    "current_version_number": 1,
    "draft_version_number": 1,
    "entity_type": "text",
    "datasource_ids": [
      "text"
    ],
    "access_profiles_used": [
      "text"
    ],
    "provider_external_ids": [
      "text"
    ],
    "current_version": {
      "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,
                "display_name": "text"
              }
            ],
            "continuous_sync": true,
            "name": "text",
            "state": 1,
            "display_name": "text",
            "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,
            "trigger_properties": [
              "text"
            ],
            "details": "text",
            "safety_limit_settings": {
              "enable_change_limit": true,
              "enable_predictive_change_limit": true,
              "max_identities_affected_percentage": 1,
              "max_identities_affected_count": "text",
              "warning_email_addresses": [
                "text"
              ],
              "max_workflow_runs_percentage": 1,
              "max_workflow_runs_count": "text"
            }
          }
        ],
        "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,
                "display_name": "text"
              }
            ],
            "action_notification_settings": [
              {
                "notification_settings": {
                  "notification_type": 1,
                  "notification_id": "text",
                  "email_settings": {
                    "emails": [
                      "text"
                    ],
                    "extra_email_fields": [
                      "text"
                    ],
                    "email_formatters": [
                      {
                        "formatter": "text",
                        "pipeline_functions": "text"
                      }
                    ]
                  },
                  "webhook_settings": {
                    "webhook_url": "text",
                    "webhook_auth_header": "text",
                    "webhook_method": "text",
                    "webhook_headers": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    }
                  }
                },
                "on_success": true,
                "on_failure": true,
                "on_success_custom_template_id": "text",
                "on_failure_custom_template_id": "text"
              }
            ],
            "state": 1,
            "run_once": true,
            "display_name": "text",
            "continue_workflow_on_error": true
          }
        ],
        "attribute_common_transformers": [
          {
            "name": "text",
            "description": "text",
            "entity_type": "text",
            "entity_attribute_transformers": [
              {
                "destination_attribute": "text",
                "destination_value_formatter": "text",
                "formatter_type": 1,
                "continuous_sync": true,
                "additional_value_formatter": [
                  "text"
                ],
                "pipeline_functions": "text",
                "unique_identifier": true
              }
            ],
            "datasource_id": "text"
          }
        ],
        "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
            }
          }
        ],
        "alias_definitions": {
          "ANY_ADDITIONAL_PROPERTY": {
            "entity_type": "text",
            "provider_id": "text"
          }
        }
      },
      "config_version": "text",
      "created_by": "text",
      "created_at": "2026-02-26T23:13:34.410Z",
      "updated_at": "2026-02-26T23:13:34.410Z",
      "published_by": "text",
      "published_at": "2026-02-26T23:13:34.410Z",
      "last_edited_by": "text",
      "last_edited_at": "2026-02-26T23:13:34.410Z"
    },
    "initial_complete": true,
    "secondary_source_of_identities": [
      {
        "entity_type": "text",
        "datasource_ids": [
          "text"
        ],
        "provider_external_ids": [
          "text"
        ],
        "correlation_attribute_names": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "only_enrich_existing": true,
        "skip_workflow_runs_on_extraction": true
      }
    ],
    "sync_only_when_source_changes": true,
    "time_before_sync_if_no_source_changes_in_minutes": 1,
    "identity_attribute_mappings": [
      {
        "identity_attribute": 1,
        "entity_attribute_name": "text"
      }
    ],
    "safety_limit_settings": {
      "enable_change_limit": true,
      "enable_predictive_change_limit": true,
      "max_identities_affected_percentage": 1,
      "max_identities_affected_count": "text",
      "warning_email_addresses": [
        "text"
      ],
      "max_workflow_runs_percentage": 1,
      "max_workflow_runs_count": "text"
    },
    "safety_limit_warning": {
      "warning_type": 1,
      "occurred_at": "2026-02-26T23:13:34.410Z",
      "caused_by_extraction_event": {
        "id": "text",
        "data_source_id": "text",
        "provider_id": "text",
        "provider_type": "text",
        "state": 1,
        "provider_external_id": "text",
        "agent_type": 1,
        "error_message": "text",
        "extracted_at": "2026-02-26T23:13:34.410Z",
        "policy_id": "text",
        "event_type": 1,
        "number_of_identities_affected": "text",
        "disregard_change_limit": true,
        "workflow_safety_limit_info": {
          "safety_limit_info_map": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "identities_changed_count": "text",
      "predicted_identities_changed_count": "text",
      "predicted_workflow_runs_count": "text",
      "workflow_counts": {
        "ANY_ADDITIONAL_PROPERTY": {
          "identities_changed_count": "text",
          "predicted_workflow_runs_count": "text"
        }
      }
    },
    "no_retry_for_failed_workflow": true,
    "max_retries_for_failed_workflow": 1,
    "skip_workflow_runs_on_extraction": true,
    "valid_identity_settings": {
      "enabled": true,
      "valid_identity_filter": "text",
      "invalid_identity_filter": "text",
      "max_invalid_events": 1,
      "max_invalid_allowed_to_proceed": 1
    },
    "event_notification_settings": [
      {
        "event_type": 1,
        "notification_settings": {
          "notification_type": 1,
          "notification_id": "text",
          "email_settings": {
            "emails": [
              "text"
            ],
            "extra_email_fields": [
              "text"
            ],
            "email_formatters": [
              {
                "formatter": "text",
                "pipeline_functions": "text"
              }
            ]
          },
          "webhook_settings": {
            "webhook_url": "text",
            "webhook_auth_header": "text",
            "webhook_method": "text",
            "webhook_headers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        },
        "on_success": true,
        "on_failure": true,
        "on_success_custom_template_id": "text",
        "on_failure_custom_template_id": "text"
      }
    ],
    "created_by": "text",
    "created_at": "2026-02-26T23:13:34.410Z",
    "updated_at": "2026-02-26T23:13:34.410Z"
  },
  "version": {
    "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,
              "display_name": "text"
            }
          ],
          "continuous_sync": true,
          "name": "text",
          "state": 1,
          "display_name": "text",
          "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,
          "trigger_properties": [
            "text"
          ],
          "details": "text",
          "safety_limit_settings": {
            "enable_change_limit": true,
            "enable_predictive_change_limit": true,
            "max_identities_affected_percentage": 1,
            "max_identities_affected_count": "text",
            "warning_email_addresses": [
              "text"
            ],
            "max_workflow_runs_percentage": 1,
            "max_workflow_runs_count": "text"
          }
        }
      ],
      "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,
              "display_name": "text"
            }
          ],
          "action_notification_settings": [
            {
              "notification_settings": {
                "notification_type": 1,
                "notification_id": "text",
                "email_settings": {
                  "emails": [
                    "text"
                  ],
                  "extra_email_fields": [
                    "text"
                  ],
                  "email_formatters": [
                    {
                      "formatter": "text",
                      "pipeline_functions": "text"
                    }
                  ]
                },
                "webhook_settings": {
                  "webhook_url": "text",
                  "webhook_auth_header": "text",
                  "webhook_method": "text",
                  "webhook_headers": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  }
                }
              },
              "on_success": true,
              "on_failure": true,
              "on_success_custom_template_id": "text",
              "on_failure_custom_template_id": "text"
            }
          ],
          "state": 1,
          "run_once": true,
          "display_name": "text",
          "continue_workflow_on_error": true
        }
      ],
      "attribute_common_transformers": [
        {
          "name": "text",
          "description": "text",
          "entity_type": "text",
          "entity_attribute_transformers": [
            {
              "destination_attribute": "text",
              "destination_value_formatter": "text",
              "formatter_type": 1,
              "continuous_sync": true,
              "additional_value_formatter": [
                "text"
              ],
              "pipeline_functions": "text",
              "unique_identifier": true
            }
          ],
          "datasource_id": "text"
        }
      ],
      "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
          }
        }
      ],
      "alias_definitions": {
        "ANY_ADDITIONAL_PROPERTY": {
          "entity_type": "text",
          "provider_id": "text"
        }
      }
    },
    "config_version": "text",
    "created_by": "text",
    "created_at": "2026-02-26T23:13:34.410Z",
    "updated_at": "2026-02-26T23:13:34.410Z",
    "published_by": "text",
    "published_at": "2026-02-26T23:13:34.410Z",
    "last_edited_by": "text",
    "last_edited_at": "2026-02-26T23:13:34.410Z"
  }
}

Request

Request Body

Field	Type	Required	Description
name	string	Yes	Human-readable name for the policy
description	string	No	Detailed description of the policy's purpose
state	string	No	Initial policy state: INITIAL, RUNNING, PAUSED, DRY_RUN, PENDING (default: INITIAL)
datasource_ids	array[string]	Yes	The source of truth data source(s) for this policy (must have one and must be of the same type)
event_notification_settings	array[object]	No	What notifications are to be sent when an event occurs
secondary_source_of_identities	array[object]	No	Allows the ability to enrich the primary source of identity
sync_only_when_source_changes	boolean	No	If true will only sync if the source of identity changes
time_before_sync_if_no_source_changes_in_minutes	integer	No	If sync_only_when_source_changes is true, how quickly (in minutes) to run a check when no changes are detected (default is 1 day 1440)
identity_attribute_mappings	array[object]	No	Mappings between the Identity attributes and the SOI attribute
safety_limit_settings	object	No	Settings that determine when to block changes and send warnings
no_retry_for_failed_workflow	boolean	No	If true will not retry failed workflows
max_retries_for_failed_workflow	integer	No	How many times we will retry a failed workflow (default is 10)

Complex Field Details

Event Notification Settings: The event_notification_settings array contains objects that define when and how to send notifications:

Field	Type	Description
event_type	string	The type of event that triggers the notification
notification_settings	object	Configuration for how notifications are sent

Secondary Source of Identity: The secondary_source_of_identities array allows enriching the primary source of identity:

Field	Type	Description
datasource_ids	array[string]	Data sources for the secondary identity source
correlation_attribute_names	object	Key-value pairs mapping primary to secondary attributes
only_enrich_existing	boolean	If true, only enriches existing identities, doesn't create new ones

Identity Attribute Mappings: The identity_attribute_mappings array maps identity attributes to entity attributes:

Field	Type	Description
identity_attribute	string	The identity attribute type (EMAIL, TITLE, EMPLOYEE_ID, DEPARTMENT, MANAGER_IDS)
entity_attribute_name	string	The name of the entity attribute to map to

Safety Limit Settings: The safety_limit_settings object prevents mass changes. Two independent mechanisms are available:

• Hard Limit (enable_change_limit): Reactive — stops processing during execution when the configured identity change threshold is reached.

• Predictive Safety Limit (enable_predictive_change_limit): Proactive — blocks all changes before execution if predicted workflow runs exceed the threshold.

Field	Type	Description
enable_change_limit	boolean	Enable the Hard Limit (reactive — stops when identity change threshold is reached during processing)
enable_predictive_change_limit	boolean	Enable the Predictive Safety Limit (proactive — blocks before processing if predicted workflow runs exceed threshold)
max_identities_affected_count	integer	Maximum number of identities that can be affected. Used by Hard Limit
max_workflow_runs_count	integer	Maximum number of predicted workflow runs before blocking. Used by Predictive Safety Limit
warning_email_addresses	array[string]	Email addresses to notify when safety limits are triggered

Safety limit settings can also be configured at the individual workflow level within the policy version configuration for granular control over different workflow types.

Request Examples

Basic Policy Creation

curl -X POST "https://your-tenant.vezacloud.com/api/private/lifecycle_management/policies" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Employee Onboarding Policy",
    "description": "Automated access provisioning for new employees",
    "state": "INITIAL",
    "datasource_ids": ["549a4b5e-0328-4c87-a19d-ee8a2926d1aa"]
  }'

Response

post

Authorizations

bearerAuth

AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Body

application/json

namestringOptional

descriptionstringOptional

stateinteger · enumOptional

datasource_idsstring[]Optional

The source of truth data source(s) for this policy (must have one and must be of the same type)

sync_only_when_source_changesbooleanOptional

If true will only sync if the source of identity changes

time_before_sync_if_no_source_changes_in_minutesinteger · int32Optional

If sync_only_when_source_changes is true, how quickly (in minutes) to run a check when no changes are detected (default is 1 day 1440)

no_retry_for_failed_workflowbooleanOptional

if true will not retry failed workflows

max_retries_for_failed_workflowinteger · int32Optional

how many times we will retry a failed workflow (default is 10)

skip_workflow_runs_on_extractionbooleanOptional

if true, the workflow runs will be skipped for the extractions related to this Primary SOI

Responses

200

OK

application/json

default

Default error response

application/json

post

/api/private/lifecycle_management/policies

HTTPcURLJavaScriptPython

POST /api/private/lifecycle_management/policies HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1514

{
  "name": "text",
  "description": "text",
  "state": 1,
  "datasource_ids": [
    "text"
  ],
  "event_notification_settings": [
    {
      "event_type": 1,
      "notification_settings": {
        "notification_type": 1,
        "notification_id": "text",
        "email_settings": {
          "emails": [
            "text"
          ],
          "extra_email_fields": [
            "text"
          ],
          "email_formatters": [
            {
              "formatter": "text",
              "pipeline_functions": "text"
            }
          ]
        },
        "webhook_settings": {
          "webhook_url": "text",
          "webhook_auth_header": "text",
          "webhook_method": "text",
          "webhook_headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "on_success": true,
      "on_failure": true,
      "on_success_custom_template_id": "text",
      "on_failure_custom_template_id": "text"
    }
  ],
  "secondary_source_of_identities": [
    {
      "datasource_ids": [
        "text"
      ],
      "correlation_attribute_names": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "only_enrich_existing": true,
      "skip_workflow_runs_on_extraction": true
    }
  ],
  "sync_only_when_source_changes": true,
  "time_before_sync_if_no_source_changes_in_minutes": 1,
  "identity_attribute_mappings": [
    {
      "identity_attribute": 1,
      "entity_attribute_name": "text"
    }
  ],
  "safety_limit_settings": {
    "enable_change_limit": true,
    "enable_predictive_change_limit": true,
    "max_identities_affected_percentage": 1,
    "max_identities_affected_count": "text",
    "warning_email_addresses": [
      "text"
    ],
    "max_workflow_runs_percentage": 1,
    "max_workflow_runs_count": "text"
  },
  "no_retry_for_failed_workflow": true,
  "max_retries_for_failed_workflow": 1,
  "skip_workflow_runs_on_extraction": true,
  "valid_identity_settings": {
    "enabled": true,
    "valid_identity_filter": "text",
    "invalid_identity_filter": "text",
    "max_invalid_events": 1,
    "max_invalid_allowed_to_proceed": 1
  }
}

{
  "value": {
    "id": "text",
    "name": "text",
    "description": "text",
    "state": 1,
    "current_version_number": 1,
    "draft_version_number": 1,
    "entity_type": "text",
    "datasource_ids": [
      "text"
    ],
    "access_profiles_used": [
      "text"
    ],
    "provider_external_ids": [
      "text"
    ],
    "current_version": {
      "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,
                "display_name": "text"
              }
            ],
            "continuous_sync": true,
            "name": "text",
            "state": 1,
            "display_name": "text",
            "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,
            "trigger_properties": [
              "text"
            ],
            "details": "text",
            "safety_limit_settings": {
              "enable_change_limit": true,
              "enable_predictive_change_limit": true,
              "max_identities_affected_percentage": 1,
              "max_identities_affected_count": "text",
              "warning_email_addresses": [
                "text"
              ],
              "max_workflow_runs_percentage": 1,
              "max_workflow_runs_count": "text"
            }
          }
        ],
        "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,
                "display_name": "text"
              }
            ],
            "action_notification_settings": [
              {
                "notification_settings": {
                  "notification_type": 1,
                  "notification_id": "text",
                  "email_settings": {
                    "emails": [
                      "text"
                    ],
                    "extra_email_fields": [
                      "text"
                    ],
                    "email_formatters": [
                      {
                        "formatter": "text",
                        "pipeline_functions": "text"
                      }
                    ]
                  },
                  "webhook_settings": {
                    "webhook_url": "text",
                    "webhook_auth_header": "text",
                    "webhook_method": "text",
                    "webhook_headers": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    }
                  }
                },
                "on_success": true,
                "on_failure": true,
                "on_success_custom_template_id": "text",
                "on_failure_custom_template_id": "text"
              }
            ],
            "state": 1,
            "run_once": true,
            "display_name": "text",
            "continue_workflow_on_error": true
          }
        ],
        "attribute_common_transformers": [
          {
            "name": "text",
            "description": "text",
            "entity_type": "text",
            "entity_attribute_transformers": [
              {
                "destination_attribute": "text",
                "destination_value_formatter": "text",
                "formatter_type": 1,
                "continuous_sync": true,
                "additional_value_formatter": [
                  "text"
                ],
                "pipeline_functions": "text",
                "unique_identifier": true
              }
            ],
            "datasource_id": "text"
          }
        ],
        "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
            }
          }
        ],
        "alias_definitions": {
          "ANY_ADDITIONAL_PROPERTY": {
            "entity_type": "text",
            "provider_id": "text"
          }
        }
      },
      "config_version": "text",
      "created_by": "text",
      "created_at": "2026-02-26T23:13:34.410Z",
      "updated_at": "2026-02-26T23:13:34.410Z",
      "published_by": "text",
      "published_at": "2026-02-26T23:13:34.410Z",
      "last_edited_by": "text",
      "last_edited_at": "2026-02-26T23:13:34.410Z"
    },
    "initial_complete": true,
    "secondary_source_of_identities": [
      {
        "entity_type": "text",
        "datasource_ids": [
          "text"
        ],
        "provider_external_ids": [
          "text"
        ],
        "correlation_attribute_names": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "only_enrich_existing": true,
        "skip_workflow_runs_on_extraction": true
      }
    ],
    "sync_only_when_source_changes": true,
    "time_before_sync_if_no_source_changes_in_minutes": 1,
    "identity_attribute_mappings": [
      {
        "identity_attribute": 1,
        "entity_attribute_name": "text"
      }
    ],
    "safety_limit_settings": {
      "enable_change_limit": true,
      "enable_predictive_change_limit": true,
      "max_identities_affected_percentage": 1,
      "max_identities_affected_count": "text",
      "warning_email_addresses": [
        "text"
      ],
      "max_workflow_runs_percentage": 1,
      "max_workflow_runs_count": "text"
    },
    "safety_limit_warning": {
      "warning_type": 1,
      "occurred_at": "2026-02-26T23:13:34.410Z",
      "caused_by_extraction_event": {
        "id": "text",
        "data_source_id": "text",
        "provider_id": "text",
        "provider_type": "text",
        "state": 1,
        "provider_external_id": "text",
        "agent_type": 1,
        "error_message": "text",
        "extracted_at": "2026-02-26T23:13:34.410Z",
        "policy_id": "text",
        "event_type": 1,
        "number_of_identities_affected": "text",
        "disregard_change_limit": true,
        "workflow_safety_limit_info": {
          "safety_limit_info_map": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "identities_changed_count": "text",
      "predicted_identities_changed_count": "text",
      "predicted_workflow_runs_count": "text",
      "workflow_counts": {
        "ANY_ADDITIONAL_PROPERTY": {
          "identities_changed_count": "text",
          "predicted_workflow_runs_count": "text"
        }
      }
    },
    "no_retry_for_failed_workflow": true,
    "max_retries_for_failed_workflow": 1,
    "skip_workflow_runs_on_extraction": true,
    "valid_identity_settings": {
      "enabled": true,
      "valid_identity_filter": "text",
      "invalid_identity_filter": "text",
      "max_invalid_events": 1,
      "max_invalid_allowed_to_proceed": 1
    },
    "event_notification_settings": [
      {
        "event_type": 1,
        "notification_settings": {
          "notification_type": 1,
          "notification_id": "text",
          "email_settings": {
            "emails": [
              "text"
            ],
            "extra_email_fields": [
              "text"
            ],
            "email_formatters": [
              {
                "formatter": "text",
                "pipeline_functions": "text"
              }
            ]
          },
          "webhook_settings": {
            "webhook_url": "text",
            "webhook_auth_header": "text",
            "webhook_method": "text",
            "webhook_headers": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        },
        "on_success": true,
        "on_failure": true,
        "on_success_custom_template_id": "text",
        "on_failure_custom_template_id": "text"
      }
    ],
    "created_by": "text",
    "created_at": "2026-02-26T23:13:34.410Z",
    "updated_at": "2026-02-26T23:13:34.410Z"
  },
  "version": {
    "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,
              "display_name": "text"
            }
          ],
          "continuous_sync": true,
          "name": "text",
          "state": 1,
          "display_name": "text",
          "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,
          "trigger_properties": [
            "text"
          ],
          "details": "text",
          "safety_limit_settings": {
            "enable_change_limit": true,
            "enable_predictive_change_limit": true,
            "max_identities_affected_percentage": 1,
            "max_identities_affected_count": "text",
            "warning_email_addresses": [
              "text"
            ],
            "max_workflow_runs_percentage": 1,
            "max_workflow_runs_count": "text"
          }
        }
      ],
      "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,
              "display_name": "text"
            }
          ],
          "action_notification_settings": [
            {
              "notification_settings": {
                "notification_type": 1,
                "notification_id": "text",
                "email_settings": {
                  "emails": [
                    "text"
                  ],
                  "extra_email_fields": [
                    "text"
                  ],
                  "email_formatters": [
                    {
                      "formatter": "text",
                      "pipeline_functions": "text"
                    }
                  ]
                },
                "webhook_settings": {
                  "webhook_url": "text",
                  "webhook_auth_header": "text",
                  "webhook_method": "text",
                  "webhook_headers": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  }
                }
              },
              "on_success": true,
              "on_failure": true,
              "on_success_custom_template_id": "text",
              "on_failure_custom_template_id": "text"
            }
          ],
          "state": 1,
          "run_once": true,
          "display_name": "text",
          "continue_workflow_on_error": true
        }
      ],
      "attribute_common_transformers": [
        {
          "name": "text",
          "description": "text",
          "entity_type": "text",
          "entity_attribute_transformers": [
            {
              "destination_attribute": "text",
              "destination_value_formatter": "text",
              "formatter_type": 1,
              "continuous_sync": true,
              "additional_value_formatter": [
                "text"
              ],
              "pipeline_functions": "text",
              "unique_identifier": true
            }
          ],
          "datasource_id": "text"
        }
      ],
      "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
          }
        }
      ],
      "alias_definitions": {
        "ANY_ADDITIONAL_PROPERTY": {
          "entity_type": "text",
          "provider_id": "text"
        }
      }
    },
    "config_version": "text",
    "created_by": "text",
    "created_at": "2026-02-26T23:13:34.410Z",
    "updated_at": "2026-02-26T23:13:34.410Z",
    "published_by": "text",
    "published_at": "2026-02-26T23:13:34.410Z",
    "last_edited_by": "text",
    "last_edited_at": "2026-02-26T23:13:34.410Z"
  }
}

Example Response

{
  "value": {
    "access_profiles_used": [],
    "created_at": "2024-07-15T16:14:05.810837840Z",
    "created_by": "eacb938c-431b-4023-93b1-417eb16b9fdf",
    "current_version": {
      "policy_id": "d5af38e8-df8e-416b-80cc-3aafb6bef594",
      "version_number": 1,
      "state": "DRAFT",
      "config": {
        "workflows": [],
        "actions": [],
        "attribute_common_transformers": []
      }
    },
    "current_version_number": 1,
    "datasource_ids": [
      "549a4b5e-0328-4c87-a19d-ee8a2926d1aa"
    ],
    "description": "Automated access provisioning for new employees",
    "draft_version_number": 0,
    "entity_type": "WorkdayWorker",
    "event_notification_settings": [],
    "id": "d5af38e8-df8e-416b-80cc-3aafb6bef594",
    "initial_complete": false,
    "name": "Employee Onboarding Policy",
    "provider_external_ids": [
      "https://wd5-impl-services1.workday.com/veza_preview"
    ],
    "secondary_source_of_identities": [],
    "state": "INITIAL",
    "updated_at": "2024-07-15T16:14:05.810837840Z"
  }
}