List Policies

Retrieve all policies in your Lifecycle Management configuration with filtering options

Endpoint

GET /api/private/lifecycle_management/policies

Description

Retrieve a list of all policies in your Veza Lifecycle Management configuration. This endpoint returns policies across all states (active, inactive, draft) and provides essential metadata for each policy including creation time, last modification, and current state.

Use this endpoint to:

• Get an overview of all configured policies

• Filter policies by state or other criteria

• Build policy management interfaces

• Audit policy configurations across your organization

Authentication Required

This endpoint requires a valid Veza API key for authentication.

See Authentication for more about creating and managing API keys.

All requests must include the API key as a Bearer token in the Authorization header.

Example:

curl -X GET "$BASE_URL/api/preview/keys" \
  -H "authorization: Bearer $VEZA_TOKEN"

API Reference

get

Authorizations

Query parameters

filterstringOptional

order_bystringOptional

page_sizeinteger · int32Optional

page_tokenstringOptional

Responses

200

OK

application/json

default

Default error response

application/json

get

HTTPcURLJavaScriptPython

GET /api/private/lifecycle_management/policies HTTP/1.1
Host: your-tenant.cookiecloud.ai
Authorization: Bearer JWT
Accept: */*

{
  "values": [
    {
      "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
                }
              ],
              "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-08-25T14:55:45.265Z",
        "updated_at": "2025-08-25T14:55:45.265Z",
        "published_by": "text",
        "published_at": "2025-08-25T14:55:45.265Z"
      },
      "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
        }
      ],
      "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"
        ]
      },
      "safety_limit_warning": {
        "warning_type": 1,
        "occurred_at": "2025-08-25T14:55:45.265Z",
        "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": "2025-08-25T14:55:45.265Z",
          "policy_id": "text",
          "event_type": 1,
          "number_of_identities_affected": "text",
          "disregard_change_limit": true
        },
        "identities_changed_count": "text",
        "predicted_identities_changed_count": "text"
      },
      "no_retry_for_failed_workflow": true,
      "max_retries_for_failed_workflow": 1,
      "event_notification_settings": [
        {
          "event_type": 1,
          "notification_settings": {
            "notification_type": 1,
            "notification_id": "text",
            "type_settings": {
              "@type": "text",
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "on_success": true,
          "on_failure": true
        }
      ],
      "created_by": "text",
      "created_at": "2025-08-25T14:55:45.265Z",
      "updated_at": "2025-08-25T14:55:45.265Z"
    }
  ],
  "next_page_token": "text",
  "has_more": true
}

Request Examples

curl -X GET "https://your-tenant.vezacloud.com/api/private/lifecycle_management/policies?limit=50&state=active" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Response Examples

{
  "data": [
    {
      "id": "policy-123e4567-e89b-12d3-a456-426614174000",
      "name": "Onboarding Access Policy",
      "description": "Automatically provision access for new employees",
      "state": "active",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-02-01T14:22:00Z",
      "created_by": "[email protected]",
      "configuration": {
        "conditions": [
          {
            "type": "user_attribute",
            "attribute": "department",
            "operator": "equals",
            "value": "Engineering"
          }
        ],
        "actions": [
          {
            "type": "grant_access",
            "resource": "development-tools",
            "access_level": "read_write"
          }
        ]
      }
    }
  ],
  "pagination": {
    "total": 25,
    "limit": 50,
    "offset": 0,
    "has_more": false
  }
}