The Veza management APIs enable internal tooling to automate administration of cloud providers and data sources. These APIs provide both unified and provider-specific endpoints to manage integrations:

• Provider Management API: Unified endpoints for managing all provider types through a single interface

• Provider-Specific APIs: Specialized endpoints for individual provider types with extended configuration options

• Data Sources API: Management of individual data sources within providers

Each supported provider can be managed through either the unified Provider Management API or provider-specific endpoints, depending on your needs.

Notes

• A data plane ID is required when adding a custom provider.

  • This value refers to the Insight Point used for discovery, or the GUID of the built-in data plane.

  • To get all available IDs, navigate to Administration > Insight Point.

  • Unless you have deployed an Insight Point within your environment, the only entry will be for the internal data plane.

• If a request is unsuccessful, an error message will provide additional details and troubleshooting steps.

Authentication

You can issue new API keys from Administration > API Keys > Add New API Key. Provide the key as the bearer auth token in the header of each request.

Users must have the admin role to add/modify provider configurations. Configurations can be viewed by users with the operator role.

Sample Integrations and Tools

Register Accounts - Use the management API to add multiple AWS accounts from CSV.

Veza Python Client - Simple Python class for making REST API calls to Veza.

Cloud Formation Stacks - Configure multiple AWS accounts for Veza discovery by enabling the required assume role operations and IAM permissions.

Open Authorization APIs

If your organization uses applications, data sources, or identity providers not natively supported by Veza, you may be able to add them to your data catalog using Open Authorization APIs. You will need to query the provider to retrieve entity and permissions metadata and push the payload to Veza for parsing in a template format.

Endpoints for administering custom resources (/providers/custom/*) are described in OAA Push API.

Manage entity ownership in the Veza Access Graph using the Owners API. Use List Available Owners to discover valid owner candidates, then Batch Set Owners to assign, add, or remove owners across multiple entities in a single request.

Owner updates are applied asynchronously — changes typically reflect within a few seconds of the API returning.

Endpoints

The v1/providers API includes endpoints to enable or disable integrations by provider id. This allows you to temporarily pause data extraction and synchronization for specific providers when needed, without deleting the configuration.

The provider_id value should be obtained from the provider listing APIs (e.g., /api/v1/providers/aws for AWS providers)

Enable Provider

Activate a provider connection that was disabled.

curl -X PUT \
  "https://{tenant}.vezacloud.com/api/v1/providers/{id}:enable" \
  -H "accept: application/json" \
  -H "Authorization: Bearer {your_api_key}"

Disable Provider

Deactivates a provider connection until it is-renabled, preserving the configured settings.

curl -X PUT \
  "https://{tenant}.vezacloud.com/api/v1/providers/{id}:disable" \
  -H "accept: application/json" \
  -H "Authorization: Bearer {your_api_key}"

Returns all provider types available in the tenant, including both Veza-managed integrations and custom OAA provider types.

Response

• provider_types: Veza-managed provider types such as AWS, AZURE, GOOGLE_CLOUD, OKTA, ACTIVE_DIRECTORY, GITHUB, SNOWFLAKE, SALESFORCE, KUBERNETES, and others. Each entry includes enabled: true if the tenant has at least one configured provider instance of that type.

• unregistered_custom_provider_types: OAA provider types present in the tenant that do not have a registered Veza configuration definition.

Each ProviderType includes a schema_integration_type field. Use this value (not type) when filtering by integration_type in assessment queries. The values are not always a direct transformation of the type identifier — for example, GOOGLE_CLOUD maps to google, ONE_LOGIN maps to onelogin, and MYSQL maps to my_sql.

Sample request

curl -X GET "$BASE_URL/api/v1/providers/types" \
  -H "authorization: Bearer $VEZA_TOKEN"

Sample response

{
  "provider_types": [
    {
      "type": "AWS",
      "schema_integration_type": "aws",
      "enabled": true,
      "provider_ids": ["883dd869-8762-4187-8767-1c387de14b4b"]
    },
    {
      "type": "GOOGLE_CLOUD",
      "schema_integration_type": "google",
      "enabled": false,
      "provider_ids": []
    }
  ],
  "unregistered_custom_provider_types": []
}

For detailed integration guides, see the Integrations documentation.

Manage enrichment rules using the Veza API. Enrichment rules automatically classify and tag entities in the Veza Authorization Graph based on saved query conditions.

Supported rule types (set via enriched_property):

Before creating a rule, save the target query using the Query Builder API or the Veza UI.

Endpoints

Returns all enrichment rules configured in the tenant.

Query parameters

Sample request

curl "$BASE_URL/api/v1/enrichment/rules?page_size=3" \
  -H "Authorization: Bearer $VEZA_TOKEN"

Sample response

{
  "values": [
    {
      "id": "019c4441-62c3-78f6-9dad-2b29b9b7ffee",
      "name": "AWS NHIs by property",
      "active": true,
      "provider_ids": ["5443ea52-9dba-435e-8c6a-9035cc513bfa"],
      "entity_type": "AwsIamUser",
      "property_name": "enriched_owners",
      "property_value": "{\"property_names_in_template\":[\"id\"],\"owners\":[{\"entity_id\":\"{{id}}\",\"entity_type\":\"OktaUser\"}]}",
      "node_ids": [],
      "query_id": "0198d3ff-b2f7-7b05-b3d3-14b3cfc35858",
      "priority": 6
    }
  ],
  "next_page_token": "<token>",
  "has_more": true
}

Returns the configuration and status of a single enrichment rule by ID.

Path parameter

Sample response

{
  "value": {
    "id": "019c4441-62c3-78f6-9dad-2b29b9b7ffee",
    "name": "AWS NHIs by property",
    "active": true,
    "provider_ids": ["5443ea52-9dba-435e-8c6a-9035cc513bfa"],
    "entity_type": "AwsIamUser",
    "property_name": "enriched_owners",
    "property_value": "{\"property_names_in_template\":[\"id\"],\"owners\":[{\"entity_id\":\"{{id}}\",\"entity_type\":\"OktaUser\"}]}",
    "node_ids": [],
    "query_id": "0198d3ff-b2f7-7b05-b3d3-14b3cfc35858",
    "priority": 6
  }
}

Permanently deletes an enrichment rule.

Path parameter

Notes

Deleting a rule stops future enrichment but does not roll back attributes previously applied by the rule. Entities that were classified or tagged by the rule retain those attributes until they are updated by another rule or manually changed.

Enables or disables an existing enrichment rule without deleting it. Disabled rules are not evaluated during metadata extraction.

Path parameter

Request body

curl -X PUT "$BASE_URL/api/v1/enrichment/rules/{id}:toggle" \
  -H "Authorization: Bearer $VEZA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"active": false}'

A 200 OK with an empty body indicates success.

Returns saved assessment queries that are compatible with a given entity type. Use this to discover valid query_id values before calling Create enrichment rule.

Request body

Response

Returns a queries array of ValidEnrichmentRuleQuery objects, each with an id and name. Pass the id as query_id when creating an enrichment rule.

{
  "queries": [
    {
      "id": "019d5767-2edf-7401-9c65-1d9c28f6b343",
      "name": "AWS IAM users who can delete S3 buckets"
    }
  ]
}

Returns saved assessment queries that can be used as the Owner Query for dynamic owner resolution in Entity Owner enrichment rules. The results include queries targeting IdP user entities and CMDB Configuration Items.

Use this endpoint to discover valid other_node_query_id values before calling Create enrichment rule.

Request body

Response

Returns a queries array. Each entry includes:

Example: traversal query

{
  "queries": [
    {
      "id": "019d5767-2edf-7401-9c65-1d9c28f6b343",
      "name": "AWS IAM users linked to Okta",
      "other_node_type": "OktaUser",
      "property_names": ["id", "email", "employee_id", "department"]
    }
  ]
}

Example: CMDB query

{
  "queries": [
    {
      "id": "019d5767-2edf-7401-9c65-1d9c28f6b343",
      "name": "Service accounts to CMDB config items",
      "other_node_type": "CustomCMDBConfigurationItem",
      "property_names": ["owner_node_id", "owner_external_id"]
    }
  ]
}

Related

• Create enrichment rule: using other_node_query_id in a rule

• Enrichment rules: Entity Owner: UI walkthrough and concepts

• Freshservice CMDB integration: column mapping that populates owner_node_id / owner_external_id

Returns the entities that would be affected by an enrichment rule, along with their current and projected property values. Use this endpoint to verify a rule's impact before creating or updating it.

The request accepts a full CreateEnrichmentRuleRequest body. The response is a paginated list of matching entities with enrichment-relevant properties.

Request body

Notes

• The preview reflects the current state of the Access Graph. It does not trigger extraction or persist any changes.

• For Entity Owner rules that use an other-node query, include the preview_other_node_query field to preview the resolved owner values.

Returns the total count of entities that would be affected by an enrichment rule. Use this to estimate the scope of a rule before creating it.

Request body

The request body is the same as Preview enrichment rule. See that page for field descriptions.

Response

Each cloud provider will have one or more associated data sources. Each represents a discrete instance of a service that Veza connects to for the discovery and extraction of authorization metadata.

The provider under /providers/aws/{id}, for example, may have an associated EC2 data source, represented as:

{
  "id": "6961b032-3fd7-4baa-a230-146d1b70ec27",
  "name": "AWS EC2 (527398259632)",
  "datasource_type": "EXTRACTOR",
  "agent_type": "AWS_EC2",
  "agent_category": "INFRASTRUCTURE",
  "provider_type": "AWS",
  "provider_id": "cd0cf102-e86c-4599-9cbe-64d2c6b83236",
  "path": "AWS/ec2",
  "external_id": "527398259632",
  "status": "SUCCESS",
  "previous_status": "SUCCESS",
  "state": "ENABLED",
  "effective_state": "ENABLED",
  "created_at": "2021-10-26T07:10:38Z",
  "updated_at": "2022-01-13T20:53:29Z",
  "sync_start": "2022-01-13T20:53:20Z",
  "sync_end": "2022-01-13T20:53:23Z",
  "sync_start_success": "2022-01-13T20:53:20Z",
  "sync_end_success": "2022-01-13T20:53:23Z",
  "parse_start": "2022-01-13T20:53:24Z",
  "parse_end": "2022-01-13T20:53:29Z",
  "parse_start_success": "2022-01-13T20:53:24Z",
  "parse_end_success": "2022-01-13T20:53:29Z",
  "retries": 0,
  "skipped_parses": 0
}

See Get Data Source for a full description of every field.

You can use the API to get or update data source records, or enable and disable individual data sources.

Available Endpoints

Core Data Source Operations

Lifecycle Management Operations

Status and Monitoring

Related APIs

For working with custom applications and Open Authorization API (OAA), see:

• Open Authorization API

• OAA Operations

Endpoint

GET /api/v1/providers/datasources

Description

Returns the properties and status for all data sources. When filtering is applied, only data sources matching the filter will be returned.

Data sources represent discrete instances of services that Veza connects to for discovery and extraction of authorization metadata. Each cloud provider may have one or more associated data sources.

API Reference

Query Parameters

Request Examples

curl -X GET "$BASE_URL/api/v1/providers/datasources" \
  -H "authorization: Bearer $VEZA_TOKEN"

curl -X GET "$BASE_URL/api/v1/providers/datasources?filter=status+eq+\"SUCCESS\"" \
  -H "authorization: Bearer $VEZA_TOKEN"

curl -X GET "$BASE_URL/api/v1/providers/datasources?page_size=10&order_by=name" \
  -H "authorization: Bearer $VEZA_TOKEN"

Response Examples

Standard Response:

{
  "values": [
    {
      "id": "6961b032-3fd7-4baa-a230-146d1b70ec27",
      "name": "AWS EC2 (527398259632)",
      "datasource_type": "EXTRACTOR",
      "agent_type": "AWS_EC2",
      "agent_category": "INFRASTRUCTURE",
      "provider_type": "AWS",
      "provider_id": "cd0cf102-e86c-4599-9cbe-64d2c6b83236",
      "path": "AWS/ec2",
      "external_id": "527398259632",
      "status": "SUCCESS",
      "previous_status": "SUCCESS",
      "state": "ENABLED",
      "effective_state": "ENABLED",
      "created_at": "2021-10-26T07:10:38Z",
      "updated_at": "2022-01-13T20:53:29Z",
      "sync_start": "2022-01-13T20:53:20Z",
      "sync_end": "2022-01-13T20:53:23Z",
      "sync_start_success": "2022-01-13T20:53:20Z",
      "sync_end_success": "2022-01-13T20:53:23Z",
      "parse_start": "2022-01-13T20:53:24Z",
      "parse_end": "2022-01-13T20:53:29Z",
      "parse_start_success": "2022-01-13T20:53:24Z",
      "parse_end_success": "2022-01-13T20:53:29Z",
      "retries": 0,
      "skipped_parses": 0
    }
  ],
  "next_page_token": "ec67g",
  "has_more": false
}

Response Fields

Each object in values has the same fields as the Get Data Source response. See Get Data Source → Response Fields for a description of every field, including status values and the error object.

Endpoint

POST /api/v1/providers/datasources:list

Description

DataSourcesList is the POST/body counterpart of List Data Sources. It accepts the request parameters in the body so that ids and external_ids lists travel in the request body instead of the query string, enabling batch fetch by ID without a URL-length limit.

Use this endpoint when an integration needs to retrieve a known set of data sources in a single call. The SCIM filter query string supported by ListDataSources only allows single-value EQ and has no IN operator, which forces clients to either issue N parallel GetDataSource calls or to page through the full list. DataSourcesList removes that constraint: the ids and external_ids typed lists map to a native IN lookup. Unknown IDs are silently omitted from the response — they are not treated as an error.

filter, order_by, page_size, and page_token keep the same semantics as ListDataSources. All conditions on the request are combined with AND.

Endpoint

PUT /api/v1/providers/datasources/{id}

Description

Update the name for a given data source ID. This endpoint allows you to modify the display name of an existing data source.

API Reference

Path Parameters

Request Body

Request Examples

curl -X PUT "$BASE_URL/api/v1/providers/datasources/6961b032-3fd7-4baa-a230-146d1b70ec27" \
  -H "authorization: Bearer $VEZA_TOKEN" \
  -H "Content-Type: application/json" \
  --data-raw '{
    "name": "AWS EC2 Production Environment"
  }'

Response Examples

Standard Response:

The response returns the full updated data source. See Get Data Source → Response Fields for a description of every field.

{
  "value": {
    "id": "6961b032-3fd7-4baa-a230-146d1b70ec27",
    "name": "AWS EC2 Production Environment",
    "datasource_type": "EXTRACTOR",
    "agent_type": "AWS_EC2",
    "agent_category": "INFRASTRUCTURE",
    "provider_type": "AWS",
    "provider_id": "cd0cf102-e86c-4599-9cbe-64d2c6b83236",
    "path": "AWS/ec2",
    "external_id": "527398259632",
    "status": "SUCCESS",
    "previous_status": "SUCCESS",
    "state": "ENABLED",
    "effective_state": "ENABLED",
    "created_at": "2021-10-26T07:10:38Z",
    "updated_at": "2024-01-15T10:30:45Z",
    "sync_start": "2022-01-13T20:53:20Z",
    "sync_end": "2022-01-13T20:53:23Z",
    "sync_start_success": "2022-01-13T20:53:20Z",
    "sync_end_success": "2022-01-13T20:53:23Z",
    "parse_start": "2022-01-13T20:53:24Z",
    "parse_end": "2022-01-13T20:53:29Z",
    "parse_start_success": "2022-01-13T20:53:24Z",
    "parse_end_success": "2022-01-13T20:53:29Z",
    "retries": 0,
    "skipped_parses": 0
  }
}

Endpoint

PUT /api/v1/providers/datasources/{id}:disable

Description

Pause discovery and extraction for a data source. This will cancel all pending extractions for the specified data source.

API Reference

Path Parameters

Request Examples

curl -X PUT "$BASE_URL/api/v1/providers/datasources/6961b032-3fd7-4baa-a230-146d1b70ec27:disable" \
  -H "authorization: Bearer $VEZA_TOKEN"

Response Examples

Standard Response:

{}

Endpoint

PUT /api/v1/providers/datasources/{id}:enable

Description

Resume monitoring and queue the data source for extraction. This will re-enable a previously disabled data source and schedule it for data collection.

API Reference

Path Parameters

Request Examples

curl -X PUT "$BASE_URL/api/v1/providers/datasources/6961b032-3fd7-4baa-a230-146d1b70ec27:enable" \
  -H "authorization: Bearer $VEZA_TOKEN"

Response Examples

Standard Response:

{}

Endpoint

GET /api/v1/providers/datasources/lifecycle_managers/{id}

Description

Returns detailed information for a specific lifecycle management datasource by its ID, including its supported capabilities, available actions, syncable attributes, and grantable entitlements.

API Reference

Path Parameters

Request Examples

curl -X GET "$BASE_URL/api/v1/providers/datasources/lifecycle_managers/549a4b5e-0328-4c87-a19d-ee8a2926d1aa" \
  -H "authorization: Bearer $VEZA_TOKEN"

Response Examples

{
  "value": {
    "id": "549a4b5e-0328-4c87-a19d-ee8a2926d1aa",
    "name": "Workday Integration",
    "provider_type": "WORKDAY",
    "external_id": "https://wd5-impl-services1.workday.com/veza_preview",
    "lifecycle_management_enabled": true,
    "supported_capabilities": [
      "IDENTITY_SOURCE",
      "ACCESS_TARGET"
    ]
  }
}

{
  "value": {
    "id": "549a4b5e-0328-4c87-a19d-ee8a2926d1aa",
    "name": "SCIM Demo Server",
    "provider_type": "SCIM",
    "external_id": "https://scim.example.com",
    "lifecycle_management_enabled": true,
    "supported_capabilities": [
      "ACCESS_TARGET"
    ],
    "available_actions": [
      {
        "action_type": "MANAGE_RELATIONSHIPS",
        "description": "Add or remove user memberships in groups",
        "supported_entity_types": ["User", "Group"],
        "supported_relationship_types": ["MemberOf"]
      }
    ],
    "syncable_attributes": [
      {
        "entity_type": "User",
        "attributes": [
          {
            "name": "userName",
            "type": "string",
            "required": true,
            "description": "Primary identifier for the user"
          },
          {
            "name": "displayName", 
            "type": "string",
            "required": false,
            "description": "Display name for the user"
          },
          {
            "name": "emails",
            "type": "array",
            "required": false,
            "description": "Email addresses associated with the user"
          }
        ]
      },
      {
        "entity_type": "Group",
        "attributes": [
          {
            "name": "displayName",
            "type": "string", 
            "required": true,
            "description": "Display name for the group"
          }
        ]
      }
    ],
    "grantable_entitlements": [
      {
        "entity_type": "Group",
        "entitlement_type": "MemberOf",
        "description": "Grant membership in the specified group"
      }
    ]
  }
}

For detailed information about the response fields, see the List Lifecycle Manager Datasources documentation.

Endpoint

GET /api/v1/providers/datasources/lifecycle_managers:by_action_type

Description

Returns Lifecycle Management datasources filtered by their supported action types, entity types, and relationship types. This endpoint helps you find datasources that can perform specific lifecycle management operations.

API Reference

Query Parameters

Standard Response:

Endpoint

GET /api/v1/providers/datasources/{id}/parse_status

Description

Returns the current parsing status for a specific data source, including information about the last parse operation and any errors that occurred.

API Reference

Path Parameters

Request Examples

curl -X GET "$BASE_URL/api/v1/providers/datasources/6961b032-3fd7-4baa-a230-146d1b70ec27/parse_status" \
  -H "authorization: Bearer $VEZA_TOKEN"

Response Examples

Standard Response:

{
  "value": {
    "datasource_id": "6961b032-3fd7-4baa-a230-146d1b70ec27",
    "status": "SUCCESS",
    "last_parsed_at": "2022-01-13T20:53:29Z",
    "parse_duration_seconds": 45,
    "entities_processed": 1250,
    "errors_count": 0,
    "warnings_count": 2
  }
}

Endpoint

GET /api/v1/providers/datasources/{id}/sync_status

Description

Returns the current synchronization status for a specific data source, including information about the last sync operation and any errors that occurred during data extraction.

API Reference

Path Parameters

Request Examples

curl -X GET "$BASE_URL/api/v1/providers/datasources/6961b032-3fd7-4baa-a230-146d1b70ec27/sync_status" \
  -H "authorization: Bearer $VEZA_TOKEN"

Response Examples

Standard Response:

{
  "value": {
    "datasource_id": "6961b032-3fd7-4baa-a230-146d1b70ec27",
    "status": "SUCCESS",
    "last_synced_at": "2022-01-13T20:53:23Z",
    "sync_duration_seconds": 120,
    "records_extracted": 5000,
    "errors_count": 0,
    "next_scheduled_sync": "2022-01-14T08:00:00Z"
  }
}

ListCustomProviders returns all custom (OAA-based) provider definitions configured in the Veza instance.

Each provider in the response includes its ID, name, custom template type, integration type, and associated data sources.

Sample request

curl -X GET "$BASE_URL/api/v1/providers/custom" \
  -H "authorization: Bearer $VEZA_TOKEN"

Sample response

{
  "values": [
    {
      "name": "my_custom_app",
      "custom_template": "application",
      "integration_type": "my_custom_app",
      "data_sources": [],
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

ListCustomProviderInternalConfigurationDefinitions returns the internal configuration definitions for all custom OAA providers, including built-in Veza integrations that use OAA templates.

This endpoint is useful for understanding the configuration schema of custom integrations, including connector types, data source configurations, and supported settings.

Sample request

curl -X GET "$BASE_URL/api/v1/providers/custom/configurations" \
  -H "authorization: Bearer $VEZA_TOKEN"

Endpoint: POST {veza_url}/api/v1/list_available_owners Authentication: Bearer token (admin, operator, or nhi_security_admin role)

Returns a paginated list of active IdP users that are eligible to be assigned as entity owners. Use this endpoint to populate an owner picker before calling Batch Set Owners.

Minimal Working Example

curl -X POST "https://your-tenant.veza.com/api/v1/list_available_owners" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "search_value": "alice",
    "page_size": 25
  }'

Response:

{
  "owners": [
    {
      "entity_id": "abc123",
      "entity_type": "OktaUser",
      "entity_name": "Alice Smith",
      "external_id": "alice@example.com"
    }
  ],
  "next_page_token": "eyJwYWdlIjoxfQ==",
  "has_more": true
}

Request Fields

Only active IdP users are returned. Active status is evaluated per IdP type:

If a global IdP is configured for your tenant, only that IdP's user type is returned. Otherwise, all IdP user entities are returned.

Iterate through all available owners by following next_page_token:

Stop when has_more is false or next_page_token is empty.

Use list_available_owners to discover valid candidates before assigning owners with :

1. Call list_available_owners with search_value to find a user by name or email

2. Copy the entity_id and entity_type from the response

Creates a new enrichment rule that automatically applies attributes to entities matching a saved query.

Workflow

1. Save a query using the Query Builder API or the Veza UI (Access Intelligence > Query Builder).

2. Copy the query id from the response.

3. Submit a CreateEnrichmentRule request with the query_id and one rule type field.

The rule is applied during the next metadata extraction for integrations with entities matching the saved query.

Set enriched_property to define the enrichment behavior:

For ENRICHED_OWNERS, use enriched_owners_value instead of property_value. The owners array supports template variables. Use property_names_in_template to declare the entity property containing the owner ID, then reference it as {{property_name}} in the entity_id field:

When ownership information exists on a related entity rather than the enriched entity itself, pass other_node_query_id with the ID of a saved query. The query must be one of two types:

1. Related-entity traversal: A query that traverses from the enriched entity to a related entity. The related entity either contains the owner ID in a property (referenced by property_names_in_template), or is the owner itself (use id in property_names_in_template to reference its node ID).

2. CMDB Configuration Item lookup: A query for CustomCMDBConfigurationItem. Unlike a traversal query, this does not connect directly to the enriched entity or owner. Instead, the CMDB item's asset_node_id

Use to discover compatible queries and their available properties.

Example: Related-entity traversal

In this example, other_node_query_id points to a saved query that traverses from AwsIamUser to a linked OktaUser. The id property on the related OktaUser resolves to the owner:

Example: CMDB Configuration Item lookup

In this example, other_node_query_id points to a saved query that returns CustomCMDBConfigurationItem nodes. Each CMDB item has an asset_node_id pointing to the enriched entity and an owner_node_id pointing to the owner:

For VEZA_TAGS, use tag_updates_value with add_tags and remove_tags arrays. Each tag is a {key, value} pair:

UpdateEnrichmentRule is not exposed via the public API. To replace a rule's configuration, delete and recreate it. To enable or disable a rule, use .

Endpoint

GET /api/v1/providers/datasources/lifecycle_managers

Description

Lists all data sources that have enabled lifecycle management and their detailed capabilities. This endpoint shows which systems can be used as sources of identity information and as targets for access management operations in Veza Lifecycle Management.

Use this endpoint to:

• Discover which datasources support lifecycle management

• View the capabilities each datasource provides

• Get datasource IDs needed for other lifecycle management operations

• Identify available actions, syncable attributes, and grantable entitlements for each datasource

• id: Unique identifier for the datasource

• name: Human-readable name of the datasource

• provider_type: The type of integration (e.g., SCIM, WORKDAY, ACTIVE_DIRECTORY)

The supported_capabilities field indicates what operations each datasource can perform:

• IDENTITY_SOURCE: Can provide identity information for lifecycle management

• ACCESS_TARGET: Can receive and execute access management operations

The available_actions array details specific lifecycle management operations supported:

• action_type: Type of action (e.g., MANAGE_RELATIONSHIPS)

• description: Human-readable description of the action

• supported_entity_types: Entity types this action can work with (User, Group, etc.)

The syncable_attributes array shows which entity attributes can be synchronized:

• entity_type: The type of entity (User, Group, etc.)

• attributes: Array of attribute definitions including:

  • name: Attribute name in the target system

The grantable_entitlements array shows what access can be granted through this datasource:

• entity_type: Type of entity that can grant access (typically Group)

• entitlement_type: Type of entitlement relationship (MemberOf, etc.)

• description: What access is granted through this entitlement