Azure API Management Enricher App
The Azure API Management Enricher app is designed to bring API definitions from Azure API Management into Atlan. It focuses on creating and enriching API spec and API path assets so teams can search, understand, and govern APIs alongside the rest of their data estate.
The app connects to Azure API Management to retrieve API specs and API paths, creates or updates the corresponding assets in the selected Atlan API connection, adds readmes generated from Azure metadata, and syncs Azure API Management tags to the relevant assets in Atlan.
Access
The Azure API Management Enricher app isn't enabled by default. To use this app, contact Atlan support and request it be added to your tenant.
Once enabled, only admins or users with workflow permissions can configure and run the app.
Workflow name
Specifies a unique name for identifying the workflow configuration within Atlan. This name appears in the workflow list and logs, so choose something that clearly describes which APIs or environment the workflow covers.
Example:
prod-azure-api-management-enricher
Authentication
Defines how the app authenticates with Azure to read APIs from Azure API Management.
- Service principal: Uses the Azure client ID, client secret, and tenant ID you configured in the Credentials section. The service principal must have permission in Azure API Management to read APIs and their definitions in the selected subscription, resource group, and service.
Azure client ID
The application (client) ID for the app registered in Microsoft Entra ID (formerly Azure Active Directory). The app uses this identity to authenticate with Azure APIs and request access tokens.
You can find this value in the Azure portal > Microsoft Entra ID > App registrations > [your app] > Overview page. It appears as Application (client) ID.
Example:
12345678-1234-1234-1234-123456789012
Azure client secret
The client secret for the registered app. This secret, together with the client ID, identifies the app when it requests tokens for Azure API Management and other Azure resources.
You can create or rotate this secret from Azure portal > Microsoft Entra ID > App registrations > [your app] > Certificates and secrets. Use the Value of the secret (not the name) when configuring the workflow.
Example:
abc123d45pqr678stu901vwx234
Azure tenant ID
The tenant ID of your Microsoft Entra ID instance. The app uses this value to request tokens from the correct directory so that authentication is scoped to the right organization.
You can find this in Azure portal > Microsoft Entra ID > Overview. It appears as Tenant ID.
Example:
87654321-4321-4321-4321-210987654321
Azure subscription ID
The Azure subscription that contains the API Management service you want to use as the source. This tells the app which subscription to query when looking up API Management resources.
You can find this in Azure portal > Subscriptions, or in the Overview page of your API Management instance under Subscription ID.
Example:
11111111-2222-3333-4444-555555555555
Azure API resource group
The resource group that contains the Azure API Management instance. The app uses this to locate the correct API Management service inside the subscription.
You can find this in Azure portal > Resource groups or from the Overview page of your API Management resource under Resource group.
Example:
rg-prod-api-management
Azure API service
The name of the Azure API Management service that exposes the APIs you want to sync into Atlan. This value must match the Name of the API Management instance exactly.
You can find this in Azure portal > API Management services or on the Overview page of your API Management resource under Name.
Example:
prod-api-management
Connection
The Atlan API connection where API specs and API paths from Azure API Management are created or updated. This connection must exist in Atlan before you run the workflow.
API spec name
The name of the API spec in Azure API Management that you want to import. The app uses this to identify which API or APIs to retrieve.
Depending on how the app is configured, this value can be a single API name or a pattern that matches multiple APIs.
Example:
customer-accounts-api
Need help?
If you have any issues configuring or running the Azure API Management Enricher app, contact Atlan support.