|
1 | 1 | ---
|
2 | 2 | layout: src/layouts/Default.astro
|
3 | 3 | pubDate: 2023-01-01
|
4 |
| -modDate: 2024-08-27 |
| 4 | +modDate: 2025-03-10 |
5 | 5 | title: Email notification step
|
6 | 6 | icon: fa-solid fa-envelope
|
7 | 7 | description: Email notification steps allow you to notify team members and stakeholders of deployment activities.
|
@@ -57,6 +57,36 @@ When setting up the Workload Identity Federation:
|
57 | 57 | - When granting access to the service account, the principal must have the subject attribute name set to `smtp`. Example: `https://iam.googleapis.com/projects/{project-id}/locations/global/workloadIdentityPools/{pool-id}/subject/smtp`.
|
58 | 58 | - The service account must have domain wide delegation with an OAuth scope of `https://mail.google.com/`, see [documentation](https://developers.google.com/identity/protocols/oauth2/service-account#delegatingauthority) on how to set this up.
|
59 | 59 |
|
| 60 | +### Microsoft OAuth 2.0 Credentials |
| 61 | + |
| 62 | +:::div{.warning} |
| 63 | +Support for Microsoft OAuth 2.0 authentication requires Octopus Server version 2025.2 |
| 64 | +::: |
| 65 | + |
| 66 | +Optionally for Microsoft SMTP authentication, you can use Federated Credentials and OAuth 2.0. To do this, set the following values: |
| 67 | + |
| 68 | +| Property | Description | Example | |
| 69 | +| ------------------ | ------------------------------------ | ----------- | |
| 70 | +| Audience | The audience set on the Federated Credential | Defaults to `api://AzureADTokenExchange` | |
| 71 | +| Client ID | The Azure Active Directory Application ID/Client ID | GUID in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | |
| 72 | +| Tenant ID | The Azure Active Directory Tenant ID | GUID in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | |
| 73 | + |
| 74 | +For OAuth 2.0 you will need to: |
| 75 | +1. Set up a Microsoft Entra ID App Registration. |
| 76 | + - See [documentation on registering an application](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=federated-credential%2Cexpose-a-web-api#register-an-application). |
| 77 | + - Set the configuration properties `Client ID` and `Tenant ID` with the values from your registered application. |
| 78 | +2. Add a Federated Credential. |
| 79 | + - See [documentation on adding credentials](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app?tabs=federated-credential%2Cexpose-a-web-api#add-credentials). |
| 80 | + - Set the Issuer value to a publicly accessible Octopus Server URI, this value must also not have a trailing slash (/). |
| 81 | + - Set the Subject Identifier value to `smtp`. |
| 82 | + - The Audience value can be left as the default, or set to a custom value if needed. |
| 83 | + - Set the `Audience` configuration property with the value from your federated credential. |
| 84 | +3. Configure Microsoft Exchange SMTP settings. |
| 85 | + - Add SMTP permissions for your Entra AD application, see [documentation](https://learn.microsoft.com/en-gb/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth#add-the-pop-imap-or-smtp-permissions-to-your-entra-ad-application). |
| 86 | + - Register your application's service principal in Exchange, see [documentation](https://learn.microsoft.com/en-gb/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth#register-service-principals-in-exchange). |
| 87 | + |
| 88 | + |
| 89 | + |
60 | 90 | ## Add an email step
|
61 | 91 |
|
62 | 92 | Email steps are added to deployment processes in the same way as other steps.
|
@@ -184,4 +214,4 @@ Using [custom scripts](/docs/deployments/custom-scripts) you can include additio
|
184 | 214 | #{/if}
|
185 | 215 | #{/each}
|
186 | 216 | #{/each}
|
187 |
| -``` |
| 217 | +``` |
0 commit comments