> For the complete documentation index, see [llms.txt](https://docs.veza.com/4yItIzMvkpAvMVFAamTf/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.veza.com/4yItIzMvkpAvMVFAamTf/developers/api/lifecycle-management/policies/rundryrunonidentity.md).
# Run Dry Run on Identity
Execute a policy dry run against a specific identity to preview actions without performing them
### Endpoint
```sh
POST /api/private/lifecycle_management/policies/{policy_id}/identities/{identity_id}:dry_run
```
### Description
Execute a policy dry run against a specific identity to preview what actions would be taken without actually performing them. This is essential for testing policy configurations, validating conditions, and understanding policy behavior before activation.
Use this endpoint to:
* Test new policies before activating them
* Validate policy changes against specific users
* Debug why policies are or aren't executing for certain identities
* Demonstrate policy behavior to stakeholders
* Ensure policy changes won't have unintended consequences
{% hint style="info" %}
Dry runs are read-only operations that simulate policy execution without making any actual changes to user access or system state.
{% endhint %}
### API Reference
{% openapi src="/files/Aco9gj4MY2XoNiD4zIjr" path="/api/private/lifecycle\_management/policies/{policy\_id}/identities/{id}:dry\_run" method="post" %}
[openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-c990b1c25368cfe24114b6d88a4d362095219709%2Fopenapi.yaml?alt=media)
{% endopenapi %}
### Request Examples
```bash
curl -X POST "https://your-tenant.vezacloud.com/api/private/lifecycle_management/policies/policy-123e4567-e89b-12d3-a456-426614174000/identities/identity-456:dry_run" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"policy_id": "policy-123e4567-e89b-12d3-a456-426614174000",
"id": "identity-456",
"version_number": 2,
"state": "NEW"
}'
```
### Response
{% openapi src="/files/Aco9gj4MY2XoNiD4zIjr" path="/api/private/lifecycle\_management/policies/{policy\_id}/identities/{id}:dry\_run" method="post" %}
[openapi.yaml](https://1967633068-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MZDkWMxox3pekd0NsZJ%2Fuploads%2Fgit-blob-c990b1c25368cfe24114b6d88a4d362095219709%2Fopenapi.yaml?alt=media)
{% endopenapi %}
#### Example Response
Dry Run Response
This example shows a more detailed response including job requests and workflow matching:
```json
{
"workflows_matched": [
"Active Employees"
],
"access_profile_ids": [
"3a2371b6-95ec-4d9e-b95c-d75d51daa39b",
"ead4616a-7f0e-45ad-a721-375320e15cfd"
],
"job_requests": [
{
"job_id": "fd7624af-cc5f-4b7e-87ef-e21fa9868d87",
"data_source": {
"id": "549a4b5e-0328-4c87-a19d-ee8a2926d1aa",
"name": "Workday HRIS",
"type": "workday"
},
"input_entities": [
{
"entity_id": "employee_12345",
"entity_type": "WorkdayWorker",
"attributes": {
"employment_status": "ACTIVE",
"work_location": "US",
"department": "Sales",
"manager": true
}
}
],
"action_type": "SYNC_IDENTITIES",
"action_config": {
"@type": "type.googleapis.com/lifecyclemanagement.v1.SyncIdentitiesJobConfig",
"attributes_to_sync": {
"email": "work_email",
"name": "full_name",
"department": "department_name"
},
"create_allowed": true,
"continuous_sync_allowed": true,
"attributes_not_to_continuous_sync": ["manager_approval_date"]
},
"action_job_id": "d55fda69-0720-4742-a963-f22bd8fd1b57",
"action_name": "SyncADIdentities"
},
{
"job_id": "f6b68999-43d8-49ae-8027-94e8985eafd8",
"data_source": {
"id": "ad-connector-001",
"name": "Active Directory",
"type": "active_directory"
},
"input_entities": [
{
"entity_id": "employee_12345",
"entity_type": "ActiveDirectoryUser"
}
],
"action_type": "MANAGE_RELATIONSHIPS",
"action_config": {
"@type": "type.googleapis.com/lifecyclemanagement.v1.ManageRelationshipsJobConfig",
"relationships_to_create": [
{
"entity_type": "ActiveDirectoryGroup",
"entity_id": "366db2d0-6c4e-47fe-9c57-1a8dc4916da4"
},
{
"entity_type": "ActiveDirectoryGroup",
"entity_id": "cbb024a6-e227-4aaf-b893-f61478d45f8a"
}
]
},
"action_job_id": "09b61164-d50f-4dbe-bcfc-bfff31530438",
"action_name": "UsActiveDirectoryGroups"
}
],
"messages": [
"Policy would execute for identity with email: tjones.sales@test.com",
"2 job requests generated",
"Access profiles affected: 2"
]
}
```
### Response Fields
| Field | Description |
| -------------------- | ----------------------------------------------------------- |
| `workflows_matched` | Array of workflow names that matched the dry run criteria |
| `job_requests` | Array of job request objects that would be created |
| `messages` | Array of informational messages about the dry run execution |
| `access_profile_ids` | Array of access profile IDs that were found in the dry run |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.veza.com/4yItIzMvkpAvMVFAamTf/developers/api/lifecycle-management/policies/rundryrunonidentity.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.