canonical: https://jentic.com/apis/azure.com/azure-customer-insights-management

# Microsoft Azure CustomerInsightsManagementClient

Jentic publishes the only available OpenAPI specification for CustomerInsightsManagementClient, keeping it validated and agent-ready. The Azure Customer Insights management API exposes 66 operations across 41 paths to provision and configure Customer Insights hubs and the data entities inside them. Hubs hold the customer profile graph; under each hub you can manage authorization policies, connectors, links, profiles, interactions, kpis, predictions, relationships, roles, and views. Use it to programmatically stand up a Customer Insights tenant, wire data sources into it, and define the segments and KPIs that downstream marketing tools consume.

## For AI agents

Provision Azure Customer Insights hubs and configure the connectors, profiles, KPIs, predictions, relationships, and views inside them through 66 management-plane operations.

## Scope

Does not query individual customer profile records, run real-time scoring, or send marketing campaigns - use for Customer Insights hub and configuration management only.

## Capabilities

- Create and delete Customer Insights hubs and configure their authorization policies and roles
- Define connectors to ingest customer data from Azure Blob Storage, SQL, Salesforce, and other sources, plus their connector mappings
- Manage profile, interaction, and relationship type definitions inside a hub
- Configure links between source entities and target profiles or interactions
- Create and run KPIs with measure expressions, dimensions, and threshold alerts
- Train and operate predictions (including churn and lifetime value) on the customer graph
- Manage saved views and image assets used by the Customer Insights UI

## Use cases

### Provision a Customer Insights Hub

Stand up a new Customer Insights hub through the Hubs CreateOrUpdate endpoint, specifying the SKU, hub billing info, and tenant features. Once the hub is provisioned the tenant ID is used as the prefix for all subsequent resource paths inside the hub. Hubs typically take a few minutes to provision and are ready for connector configuration immediately.

Example prompt: Create a Customer Insights hub named 'retail-prod' in resource group 'rg-ci' with SKU 'B0' and tenant features enabled, then return the hub tenant ID

### Wire Data Sources into the Customer Graph

Connect external data sources by creating a Connector resource (Azure Blob, SQL, Salesforce, ExchangeOnline, Outbound) and one or more ConnectorMappings that map source columns to target Profile or Interaction entities. The mapping defines incremental load rules, error handling, and refresh schedule. Once active the connector populates the hub's customer graph on the configured cadence.

Example prompt: Create a Salesforce connector on hub 'retail-prod' with credentials secret reference, then add a connector mapping that loads Account into a Profile of type 'Customer' on a daily refresh

### Operate KPIs and Predictions

Define KPIs (count, sum, average, min, max measures over a profile or interaction with optional dimensions) and Predictions (out-of-the-box churn or custom). The API exposes lifecycle operations to create, retrain, and delete each. KPI threshold alerts fire when the measured value crosses a defined limit, allowing automation to trigger downstream campaigns.

Example prompt: Create a KPI named 'orders-last-30d' on hub 'retail-prod' that counts Interaction:Order grouped by ProfileId and runs daily, then list KPIs to confirm creation

### Multi-Tenant Hub Management

List and manage Customer Insights hubs across an entire subscription for platform teams running multi-brand or multi-region deployments. The Hubs ListBySubscription and ListByResourceGroup endpoints return every hub the caller has access to, and per-hub Get returns the full configuration. Pair with role-assignment endpoints to control who can edit each hub.

Example prompt: List all Customer Insights hubs in subscription /subscriptions/{id} and report their SKU, location, and provisioningState

### AI Agent CDP Configuration

An AI agent supporting marketing operations can configure Customer Insights through Jentic. The agent searches by intent ('add salesforce connector to customer insights'), Jentic returns the matching Connectors_CreateOrUpdate operation with its schema, and the agent executes the call with managed Azure credentials. Re-runs of the same flow keep connectors and KPIs aligned with the marketing playbook without manual portal use.

Example prompt: Search Jentic for 'create a customer insights connector', load the Connectors_CreateOrUpdate schema, and execute it with the user-supplied connector name, type, and credentials reference

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.CustomerInsights/hubs | List all Customer Insights hubs in a subscription |
| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName} | Delete a Customer Insights hub |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies | List authorization policies on a hub |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/authorizationPolicies/{authorizationPolicyName}/regeneratePrimaryKey | Regenerate the primary key on a hub authorization policy |
| GET | /providers/Microsoft.CustomerInsights/operations | List Microsoft.CustomerInsights provider operations |

## Key resources

- **Hubs** — Provision and manage top-level Customer Insights hubs
- **Connectors** — Manage data source connectors and their connector mappings
- **Profiles** — Define and manage customer profile type definitions and their data
- **Interactions** — Define interaction types representing customer events and behaviours
- **Kpi** — Create and run KPIs with measures, dimensions, and threshold alerts
- **Predictions** — Create, train, and operate predictions like churn and custom models
- **AuthorizationPolicies** — Manage hub authorization policies and regenerate their primary or secondary keys
- **Relationships, Links, Roles, Views, Images** — Manage supporting graph and UI artefacts inside the hub

## Why Jentic

- **Setup:** Wiring Azure Customer Insights by hand means an Azure AD app registration for the OAuth implicit flow against management.azure.com, at least Contributor on the hub's resource group, and polling the Location header for long-running hub creation and prediction training yourself. Through Jentic you install once, import CustomerInsightsManagementClient from the API Directory, store the Azure AD credential once, and your agent calls it.
- **Permission scoping:** The subscription, resource group, and hub name are all URL path parameters (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}), so a rule can pin the agent to one hub. You choose the operations it may call, so destructive ones like deleting a hub or regenerating an authorization policy key are not included unless you add them.
- **Credential handling:** Your Azure service principal credentials are stored once, encrypted, by your own Jentic One instance and injected as a scoped ARM bearer token at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a Customer Insights hub' or 'add a Salesforce connector to a hub', and Jentic returns the matching operation such as Connectors_CreateOrUpdate with its input schema so the agent calls the right endpoint without loading the full 66-operation surface.

## Related APIs

- **Data Factory Management** — Build the upstream ETL pipelines that feed Customer Insights connectors with cleaned data.
- **Cosmos DB** — Store custom-built customer profile graphs directly in a multi-model database instead of a managed CDP.
- **Azure Monitor Management** — Configure metric and log alerts for Customer Insights hubs and their connector runs.

## FAQ

### Why is there no official OpenAPI spec for CustomerInsightsManagementClient?

Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call CustomerInsightsManagementClient via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Customer Insights management API use?

It uses Azure Active Directory OAuth 2.0 against https://management.azure.com/ with the user_impersonation scope. The caller needs at least Contributor on the resource group containing the hub. Jentic stores the service principal credentials encrypted and issues bearer tokens to the agent at execution time.

### Can I create connectors and connector mappings with this API?

Yes. Connectors_CreateOrUpdate creates a connector under a hub (Salesforce, Azure Blob, SQL, Exchange Online, Outbound), and ConnectorMappings_CreateOrUpdate defines how source columns map to Profile or Interaction entities including refresh schedule and error handling.

### What are the rate limits for the Customer Insights management API?

Azure Resource Manager applies subscription-level read and write throttling (around 1,200 requests per hour). Long-running operations such as hub creation or prediction training return 202 Accepted with a Location header that you poll for completion.

### How do I add a connector through Jentic?

Run pip install jentic and search for 'create customer insights connector'. Jentic returns the Connectors_CreateOrUpdate operation; load its schema and execute it with the subscriptionId, resourceGroupName, hubName, connectorName, and a body specifying the connector type and connectorProperties.

### Does this API expose customer profile data directly?

No. This is the management-plane API - it defines profile types, connectors, KPIs, and predictions, but does not return individual customer records. Profile data is queried through the Customer Insights data API on the hub's runtime endpoint.

### Can I limit what my agent is allowed to do with the Customer Insights Management API?

Yes. Because the subscription, resource group, and hub name are all URL path parameters, a rule in your self-hosted Jentic One instance can pin the agent to a single Customer Insights hub, and you decide which operations it may call. You can allow the agent to create connectors and KPIs while withholding destructive operations like deleting a hub or regenerating an authorization policy key, so those run only if you explicitly add them. Your Azure service principal credentials stay stored by your own instance and are injected as a scoped bearer token at execution time rather than exposed to the agent.