You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
API Management provides the ability to configure email notifications for specific events, and to configure the email templates that are used to communicate with the administrators and developers of an API Management instance. This article shows how to configure notifications for the available events, and provides an overview of configuring the email templates used for these events.
21
+
Azure API Management lets you configure email notifications for specific events, and configure the email templates that are used to communicate with the administrators and developers of an API Management instance. This article shows how to configure notifications for the available events, and provides an overview of configuring the email templates used for these events.
22
22
23
23
## Prerequisites
24
24
25
25
If you don't have an API Management service instance, complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md).
## <aname="publisher-notifications"> </a>Configure notifications in the portal
29
+
## <aname="publisher-notifications"> </a>Configure notifications in the Azure portal
30
30
31
-
1.In the left navigation of your API Management instance, select **Notifications** to view the available notifications.
31
+
1.From the sidebar menu of your API Management instance, select**Deployment + infrastructure**, then choose**Notifications** to view the available notifications.
32
32
33
33
The following list of events can be configured for notifications.
34
34
35
-
-**Subscription requests (requiring approval)** - The specified email recipients and users will receive email notifications about subscription requests for products requiring approval.
36
-
-**New subscriptions** - The specified email recipients and users will receive email notifications about new product subscriptions.
37
-
-**BCC** - The specified email recipients and users will receive email blind carbon copies of all emails sent to developers.
38
-
-**Close account message** - The specified email recipients and users will receive email notifications when an account is closed.
39
-
-**Approaching subscription quota limit** - The specified email recipients and users will receive email notifications when subscription usage gets close to usage quota.
35
+
-**Subscription requests (requiring approval)**: The specified email recipients and users receive email notifications about subscription requests for products requiring approval.
36
+
-**New subscriptions**: The specified email recipients and users receive email notifications about new product subscriptions.
37
+
-**Application gallery requests**: The following email recipients and users receive email notifications when new applications are submitted to the application gallery.
38
+
-**BCC**: The specified email recipients and users receive email blind carbon copies of all emails sent to developers.
39
+
-**New issue or comment**: The following email recipients and users receive email notifications when a new issue or comment is submitted on the developer portal.
40
+
-**Close account message**: The specified email recipients and users receive email notifications when an account is closed.
41
+
-**Approaching subscription quota limit**: The specified email recipients and users receive email notifications when subscription usage gets close to usage quota.
40
42
41
43
1. Select a notification, and specify one or more email addresses to be notified:
42
44
* To add the administrator email address, select **+ Add admin**.
43
45
* To add another email address, select **+ Add email**, enter an email address, and select **Add**.
44
46
* Continue adding email addresses as needed.
45
47
46
-
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-addresses.png" alt-text="Screenshot showing how to add notification recipients in the portal":::
48
+
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-addresses.png" alt-text="Screenshot showing how to add notification recipients in the portal.":::
API Management provides notification templates for the administrative email messages that are sent automatically to developers when they access and use the service. The following notification templates are provided:
Each email template has a subject in plain text, and a body definition in HTML format. Each item can be customized as desired.
54
+
- Developer farewell letter
55
+
- Developer quota limit approaching notification
56
+
- Developer welcome letter
57
+
- Email change notification
58
+
- Invite user
59
+
- New developer account confirmation
60
+
- New subscription activated
61
+
- Password change confirmation
62
+
- Subscription request declined
63
+
- Subscription request received
64
+
65
+
Each email template has a subject line in plain text, and a body definition in HTML format. Each item can be customized as desired.
67
66
68
67
> [!NOTE]
69
68
> HTML content in a template must be well-formed and adhere to the [XML specification](https://www.w3.org/XML/). The ` ` character isn't allowed.
70
69
71
70
To view and configure a notification template in the portal:
72
71
73
-
1. In the left menu, select **Notification templates**.
74
-
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-templates.png" alt-text="Screenshot of notification templates in the portal":::
72
+
1. In the sidebar menu, select **Notification templates**.
73
+
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-templates.png" alt-text="Screenshot of notification templates in the portal.":::
75
74
76
75
1. Select a notification template, and configure the template using the editor.
77
76
78
-
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-template.png" alt-text="Screenshot of notification template editor in the portal":::
77
+
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-template.png" alt-text="Screenshot of notification template editor in the portal.":::
79
78
80
-
* The **Parameters** list contains a list of parameters, which when inserted into the subject or body, will be replaced by the designated value when the email is sent.
79
+
* The **Parameters** list contains a list of parameters that, when inserted into the subject or body, are replaced by the designated value when the email is sent.
81
80
* To insert a parameter, place the cursor where you wish the parameter to go, and select the parameter name.
82
81
83
-
1. To save the changes to the email template, select **Save**, or to cancel the changes select **Discard**.
82
+
1. To save changes to the email template, select **Save**, or select **Discard** to cancel the changes.
84
83
85
84
## Configure email settings
86
85
87
86
You can modify general email settings for notifications that are sent from your API Management instance. You can change the administrator email address, the name of the organization sending notifications, and the originating email address.
88
87
89
88
> [!IMPORTANT]
90
-
> Changing the originating email address may affect recipients' ability to receive email. See the [considerations](#considerations-for-changing-the-originating-email-address) in the following section.
89
+
> Changing the originating email address might affect recipients' ability to receive email. See the [considerations](#considerations-for-changing-the-originating-email-address) in the following section.
91
90
>
92
91
To modify email settings:
93
92
94
-
1. In the left menu, select **Notification templates**.
93
+
1. In the sidebar menu, select **Notification templates**.
94
+
95
95
1. Select **E-mail settings**.
96
+
96
97
1. On the **General email settings** page, enter values for:
97
-
***Administrator email** - the email address to receive all system notifications and other configured notifications
98
-
***Organization name** - the name of your organization for use in the developer portal and notifications
99
-
***Originating email address** - The value of the `From` header for notifications from the API Management instance. API Management sends notifications on behalf of this originating address.
100
-
101
-
98
+
***Administrator email**: the email address to receive all system notifications and other configured notifications.
99
+
***Organization name**: the name of your organization for use in the developer portal and notifications.
100
+
***Originating email address**: The value of the **From** header for notifications from the API Management instance. API Management sends notifications on behalf of this originating address.
101
+
102
102
:::image type="content" source="media/api-management-howto-configure-notifications/configure-email-settings.png" alt-text="Screenshot of API Management email settings in the portal":::
103
+
103
104
1. Select **Save**.
104
105
105
106
### Considerations for changing the originating email address
106
107
107
108
Recipients of email notifications from API Management could be affected when you change the originating email address.
108
109
109
-
***Change to From address** - When you change the originating email address (for example, to `[email protected]`), the `From` address header will be `[email protected][email protected]`. This is because the email is being sent by API Management, and not the email server of the originating email address.
110
+
***Change the From address**: When you change the originating email address (for example, to `[email protected]`), the **From** address header will be `[email protected][email protected]`. This is because the email is being sent by API Management, and not the email server of the originating email address.
110
111
111
-
***Email set to Junk or Spam folder** - Some recipients may not receive the email notifications from API Management or emails may get sent to the Junk or Spam folder. This can happen depending on the organization's SPF or DKIM email authentication settings:
112
+
***Email sent to junk or spam folder**: Some recipients might not receive the email notifications from API Management, or emails might get sent to the junk or spam folder. This can happen depending on the organization's SPF or DKIM email authentication settings:
112
113
113
-
***SPF authentication** - Email might no longer pass SPF authentication after you change the originating email address domain. To ensure successful SPF authentication and delivery of email, create the following TXT record in the DNS database of the domain specified in the email address. For instance, if the email address is `[email protected]`, contact the administrator of contoso.com to add the following TXT record: **"v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"**
114
+
***SPF authentication**: Email might no longer pass SPF authentication after you change the originating email address domain. To ensure successful SPF authentication and delivery of email, create the following TXT record in the DNS database of the domain specified in the email address. For instance, if the email address is `[email protected]`, contact the administrator of `contoso.com` to add the following TXT record: **"v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"**
114
115
115
-
***DKIM authentication** - To generate a valid signature for DKIM for email authentication, API Management requires the private key associated with the domain of the originating email address. However, it is currently not possible to upload this private key in API Management. Therefore, to assign a valid signature, API Management uses the private key associated with the `mail.windowsazure.com` domain.
116
+
***DKIM authentication**: To generate a valid signature for DKIM for email authentication, API Management requires the private key associated with the domain of the originating email address. However, it's currently not possible to upload this private key in API Management. Therefore, to assign a valid signature, API Management uses the private key associated with the `mail.windowsazure.com` domain.
116
117
117
118
## Related content
118
119
119
-
*[Overview of the developer portal](api-management-howto-developer-portal.md).
120
+
*[Overview of the developer portal](api-management-howto-developer-portal.md)
120
121
*[How to create and use groups to manage developer accounts](api-management-howto-create-groups.md)
Copy file name to clipboardExpand all lines: articles/api-management/enable-cors-power-platform.md
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
-
title: Enable CORS policies for Azure API Management custom connector
2
+
title: Enable CORS Policies for Azure API Management Custom Connector
3
3
description: How to enable CORS policies in Azure API Management and Power Platform to test and use a custom connector from Power Platform applications.
4
4
services: api-management
5
5
author: dlepow
6
6
7
7
ms.service: azure-api-management
8
8
ms.topic: how-to
9
-
ms.date: 03/24/2023
9
+
ms.date: 10/07/2025
10
10
ms.author: danlep
11
11
12
12
---
@@ -16,16 +16,15 @@ ms.author: danlep
16
16
17
17
Cross-origin resource sharing (CORS) is an HTTP-header based mechanism that allows a server to indicate any origins (domain, scheme, or port) other than its own from which a browser should permit loading resources. Customers can add a [CORS policy](cors-policy.md) to their web APIs in Azure API Management, which adds cross-origin resource sharing support to an operation or an API to allow cross-domain calls from browser-based clients.
18
18
19
-
If you've exported an API from API Management as a [custom connector](export-api-power-platform.md) in the Power Platform and want to use browser-based clients including Power Apps or Power Automate to call the API, you need to configure your API to explicitly enable cross-origin requests from Power Platform applications. This article shows you how to configure the following two necessary policy settings:
19
+
If you export an API from API Management as a [custom connector](export-api-power-platform.md) in the Power Platform and want to use browser-based clients including Power Apps or Power Automate to call the API, you need to configure your API to explicitly enable cross-origin requests from Power Platform applications. This article shows you how to configure the following two necessary policy settings:
20
20
21
-
* Add a CORS policy to your API
22
-
23
-
* Add a policy to your custom connector that sets an Origin header on HTTP requests
21
+
- Add a CORS policy to your API
22
+
- Add a policy to your custom connector that sets an Origin header on HTTP requests
24
23
25
24
## Prerequisites
26
25
27
-
+ Complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md)
28
-
+ Export an API from your API Management instance to a Power Platform environment as a [custom connector](export-api-power-platform.md)
26
+
- Complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md)
27
+
- Export an API from your API Management instance to a Power Platform environment as a [custom connector](export-api-power-platform.md)
29
28
30
29
## Add CORS policy to API in API Management
31
30
@@ -38,14 +37,14 @@ Follow these steps to configure the CORS policy in API Management.
38
37
1. Add the following **Allowed origin**: `https://make.powerapps.com`.
39
38
1. Select **Save**.
40
39
41
-
* For more information about configuring a policy, see [Set or edit policies](set-edit-policies.md).
42
-
* For details about the CORS policy, see the [cors](cors-policy.md) policy reference.
40
+
- For more information about configuring a policy, see [Set or edit policies](set-edit-policies.md).
41
+
- For details about the CORS policy, see the [cors](cors-policy.md) policy reference.
43
42
44
43
> [!NOTE]
45
44
> If you already have an existing CORS policy at the service (all APIs) level to enable the test console of the developer portal, you can add the `https://make.powerapps.com` origin to that policy instead of configuring a separate policy for the API or operation.
46
45
47
46
> [!NOTE]
48
-
> Depending on how the custom connector gets used in Power Platform applications, you might need to configure additional origins in the CORS policy. If you experience CORS problems when running Power Platform applications, use developer tools in your browser, tracing in API Management, or Application Insights to investigate the issues.
47
+
> Depending on how the custom connector gets used in Power Platform applications, you might need to configure more origins in the CORS policy. If you experience CORS problems when running Power Platform applications, use developer tools in your browser, tracing in API Management, or Application Insights to investigate the issues.
49
48
50
49
51
50
## Add policy to custom connector to set Origin header
@@ -57,7 +56,7 @@ For details about editing settings of a custom connector, see [Create a custom c
57
56
1. Sign in to Power Apps or Power Automate.
58
57
1. On the left pane, select **Data** > **Custom Connectors**.
59
58
1. Select your connector from the list of custom connectors.
60
-
1.Select the pencil (Edit) icon to edit the custom connector.
59
+
1.To edit the custom connector, select the pencil (Edit) icon.
61
60
1. Select **3. Definition**.
62
61
1. In **Policies**, select **+ New policy**. Select or enter the following policy details.
63
62
@@ -79,5 +78,5 @@ For details about editing settings of a custom connector, see [Create a custom c
79
78
80
79
## Related content
81
80
82
-
*[Learn more about the Power Platform](https://powerplatform.microsoft.com/)
83
-
*[Learn more about creating and using custom connectors](/connectors/custom-connectors/)
81
+
-[Learn more about the Power Platform](https://powerplatform.microsoft.com/)
82
+
-[Learn more about creating and using custom connectors](/connectors/custom-connectors/)
![learn-build-service-prod[bot]](https://avatars.githubusercontent.com/in/237442?v=4&size=40){kind=avatar}
0 commit comments