Create Access Request

Create access requests to grant or revoke entitlements

Overview

Creates a new access request to grant or revoke entitlements, or to create/update user accounts.

post

Authorizations

bearerAuth

AuthorizationstringRequired

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

Body

application/json

request_typeinteger · enumOptional

reasonstringOptional

datasource_idstringOptional

assignee_entity_typestringOptional

assignee_entity_idstringOptional

target_entity_typestringOptional

target_entity_idsstring[]Optional

request_sourceinteger · enumOptional

request_source_idstringOptional

identity_idstringOptional

access_profile_idstringOptional

jit_duration_in_secondsinteger · int32Optional

explanationstringOptional

tracking_notification_typeinteger · enumOptional

tracking_notification_idstringOptional

catalog_definition_idstringOptional

Responses

200

OK

application/json

default

Default error response

application/json

post

/api/private/lifecycle_management/access_requests

HTTPcURLJavaScriptPython

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

{
  "request_type": 1,
  "reason": "text",
  "datasource_id": "text",
  "assignee_entity_type": "text",
  "assignee_entity_id": "text",
  "target_entity_type": "text",
  "target_entity_ids": [
    "text"
  ],
  "request_source": 1,
  "request_source_id": "text",
  "identity_id": "text",
  "access_profile_id": "text",
  "jit_duration_in_seconds": 1,
  "initial_jobs": [
    {
      "job_id": "text",
      "data_source": {
        "id": "text",
        "external_id": "text",
        "agent_type": "text",
        "data_provider_id": "text",
        "data_source_config": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "data_provider_type": 1,
        "data_provider_secret_refs": [
          {
            "secret_id": "text",
            "vault_id": "text"
          }
        ]
      },
      "input_entities": [
        {
          "entity_type": "text",
          "entity_id": "text",
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "assigned_to_entity_type": "text",
          "assigned_to_entity_id": "text",
          "entity_name": "text",
          "error_message": "text",
          "unique_identifiers": [
            "text"
          ],
          "datasource_id": "text"
        }
      ],
      "action_type": 1,
      "action_config": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "action_job_id": "text",
      "action_name": "text",
      "identity_id": "text",
      "stop_on_error": true,
      "ttl": "text"
    }
  ],
  "explanation": "text",
  "sync_config": {
    "config": {
      "entity_type": {
        "type": "text",
        "datasource_id": "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
        }
      ],
      "create_allowed": true,
      "continuous_sync": true,
      "common_transformers": [
        "text"
      ],
      "create_guest_account": true,
      "invite_guest_account": true,
      "write_back_mode": true,
      "require_password_change": true,
      "password_complexity_rule": "text"
    }
  },
  "deprovision_config": {
    "config": {
      "deprovision_type": 1,
      "entity_type": {
        "type": "text",
        "datasource_id": "text"
      },
      "remove_all_relationships": true,
      "relationships_to_create": [
        {
          "entity_type": "text",
          "entity_id": "text",
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "assigned_to_entity_type": "text",
          "assigned_to_entity_id": "text",
          "entity_name": "text",
          "error_message": "text",
          "unique_identifiers": [
            "text"
          ],
          "datasource_id": "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
        }
      ],
      "common_transformers": [
        "text"
      ],
      "logout_user": true,
      "remove_all_personal_devices": true,
      "relationships_to_not_remove": [
        {
          "entity_type": "text",
          "entity_id": "text",
          "attributes": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "assigned_to_entity_type": "text",
          "assigned_to_entity_id": "text",
          "entity_name": "text",
          "error_message": "text",
          "unique_identifiers": [
            "text"
          ],
          "datasource_id": "text"
        }
      ],
      "sync_identity_action_names": [
        "text"
      ],
      "password_complexity_rule": "text",
      "remove_only_synced_relationships": true,
      "disable_guest_account": true
    }
  },
  "delete_config": {
    "config": {
      "entity_type": {
        "type": "text",
        "datasource_id": "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
        }
      ],
      "common_transformers": [
        "text"
      ],
      "sync_identity_action_names": [
        "text"
      ]
    }
  },
  "sync_identity_action": {
    "policy_id": "text",
    "name": "text"
  },
  "tracking_notification_type": 1,
  "tracking_notification_id": "text",
  "catalog_definition_id": "text",
  "catalog_definition_config": {
    "@type": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "value": {},
  "plans": [
    {
      "id": "text",
      "state": 1,
      "request_type": 1,
      "request_source": 1,
      "plan_source": 1,
      "plan_source_id": "text",
      "plan_jobs": [
        {
          "job_id": "text",
          "data_source": {
            "id": "text",
            "external_id": "text",
            "agent_type": "text",
            "data_provider_id": "text",
            "data_source_config": {
              "@type": "text",
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "data_provider_type": 1,
            "data_provider_secret_refs": [
              {
                "id": "text",
                "secret_id": "text",
                "vault_id": "text",
                "vault": {
                  "id": "text",
                  "name": "text",
                  "vault_provider": "text",
                  "insight_point_id": "text",
                  "deleted": true
                }
              }
            ]
          },
          "input_entities": [
            {
              "entity_type": "text",
              "entity_id": "text",
              "attributes": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "assigned_to_entity_type": "text",
              "assigned_to_entity_id": "text",
              "entity_name": "text",
              "error_message": "text",
              "unique_identifiers": [
                "text"
              ],
              "datasource_id": "text"
            }
          ],
          "action_type": 1,
          "action_config": {
            "@type": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "action_job_id": "text",
          "action_name": "text",
          "identity_id": "text",
          "stop_on_error": true,
          "ttl": "text"
        }
      ],
      "error_message": "text",
      "request_source_id": "text",
      "jit_duration_in_seconds": 1,
      "jit_revoke_at": "2026-02-06T20:39:11.462Z",
      "jit_revoke_jobs": [
        {
          "job_id": "text",
          "data_source": {
            "id": "text",
            "external_id": "text",
            "agent_type": "text",
            "data_provider_id": "text",
            "data_source_config": {
              "@type": "text",
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "data_provider_type": 1,
            "data_provider_secret_refs": [
              {
                "id": "text",
                "secret_id": "text",
                "vault_id": "text",
                "vault": {
                  "id": "text",
                  "name": "text",
                  "vault_provider": "text",
                  "insight_point_id": "text",
                  "deleted": true
                }
              }
            ]
          },
          "input_entities": [
            {
              "entity_type": "text",
              "entity_id": "text",
              "attributes": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "assigned_to_entity_type": "text",
              "assigned_to_entity_id": "text",
              "entity_name": "text",
              "error_message": "text",
              "unique_identifiers": [
                "text"
              ],
              "datasource_id": "text"
            }
          ],
          "action_type": 1,
          "action_config": {
            "@type": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "action_job_id": "text",
          "action_name": "text",
          "identity_id": "text",
          "stop_on_error": true,
          "ttl": "text"
        }
      ],
      "created_at": "2026-02-06T20:39:11.462Z",
      "started_at": "2026-02-06T20:39:11.462Z",
      "completed_at": "2026-02-06T20:39:11.462Z",
      "identity_id": "text",
      "jit_revoke_completed_at": "2026-02-06T20:39:11.462Z"
    }
  ]
}

Examples

Grant Access to Groups or Roles

curl -X POST "https://your-instance.vezacloud.com/api/private/lifecycle_management/access_requests" \
  -H "authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "GRANT",
    "request_source": "ACCESS_REQUEST",
    "reason": "User needs access to project resources",
    "datasource_id": "lcm-datasource-id",
    "assignee_entity_type": "ActiveDirectoryUser",
    "assignee_entity_id": "active_directory:domain:example.com:user:jsmith",
    "target_entity_type": "ActiveDirectoryGroup",
    "target_entity_ids": ["active_directory:domain:example.com:group:developers"],
    "identity_id": "identity-abc-123"
  }'

Create or Update User Account

curl -X POST "https://your-instance.vezacloud.com/api/private/lifecycle_management/access_requests" \
  -H "authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "GRANT",
    "request_source": "ACCESS_REQUEST",
    "reason": "New employee onboarding",
    "datasource_id": "lcm-datasource-id",
    "assignee_entity_type": "OAA.SCIM.User",
    "assignee_entity_id": "scim:user:jane.smith",
    "target_entity_type": "OAA.SCIM.Group",
    "target_entity_ids": ["scim:group:employees"],
    "identity_id": "identity-def-456",
    "sync_config": {
      "config": {
        "create_allowed": true,
        "entity_attribute_transformers": [
          {
            "destination_attribute": "user_name",
            "destination_value_formatter": "jane.smith",
            "unique_identifier": true
          },
          {
            "destination_attribute": "display_name",
            "destination_value_formatter": "Jane Smith"
          },
          {
            "destination_attribute": "emails",
            "destination_value_formatter": "[email protected]"
          }
        ]
      }
    }
  }'

Revoke Access

curl -X POST "https://your-instance.vezacloud.com/api/private/lifecycle_management/access_requests" \
  -H "authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "REVOKE",
    "request_source": "ACCESS_REQUEST",
    "reason": "User role changed",
    "datasource_id": "lcm-datasource-id",
    "assignee_entity_type": "ActiveDirectoryUser",
    "assignee_entity_id": "active_directory:domain:example.com:user:jsmith",
    "target_entity_type": "ActiveDirectoryGroup",
    "target_entity_ids": ["active_directory:domain:example.com:group:developers"],
    "identity_id": "identity-abc-123"
  }'

Response

{
  "value": {
    "id": "0198cfb4-0adb-740b-8e2d-7a7c09044996",
    "reason": "User needs access to project resources",
    "datasource_id": "lcm-datasource-id",
    "assignee_entity_type": "ActiveDirectoryUser",
    "assignee_entity_id": "active_directory:domain:example.com:user:jsmith",
    "target_entity_type": "ActiveDirectoryGroup",
    "target_entity_ids": ["active_directory:domain:example.com:group:developers"],
    "request_source": "ACCESS_REQUEST",
    "state": "INITIAL",
    "request_type": "GRANT",
    "identity_id": "identity-abc-123",
    "assignee_entity_name": "Jane Smith",
    "target_entity_names": ["Developers"],
    "created_by": "user-123",
    "created_at": "2025-08-22T02:50:45.123456789Z"
  },
  "plans": [
    {
      "id": "plan-abc-123",
      "state": "INITIAL",
      "request_type": "GRANT"
    }
  ]
}