Skip to content

Commit 8b743bc

Browse files
authored
Update smtp configuration to include google oauth information (#2630)
1 parent b8abc75 commit 8b743bc

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

src/pages/docs/projects/built-in-step-templates/email-notifications.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,20 @@ You will be prompted for an email address to send a test email to. Enter a test
4343
![](/docs/projects/built-in-step-templates/images/smtp-verify-task.png)
4444
:::
4545

46+
### Google OAuth 2.0 Credentials
47+
Optionally you can use Workload Identity Federation and OAuth 2.0 for Google SMTP authentication. To do this, set the following values:
48+
49+
| Property | Description | Example |
50+
| ------------------ | ------------------------------------ | ----------- |
51+
| Audience | The audience set on the Workload Identity Federation | `https://iam.googleapis.com/projects/{project-id}/locations/global/workloadIdentityPools/{pool-id}/providers/{provider-id}` |
52+
| Service Account | The email of the service account which has been granted access | service-account-name@{project-id}.iam.gserviceaccount.com |
53+
54+
See the [Google cloud documentation](https://cloud.google.com/iam/docs/workload-identity-federation-with-other-providers) for instructions on creating and configuring a Workload Identity Federation.
55+
56+
When setting up the Workload Identity Federation:
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+
- 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+
4660
## Add an email step
4761

4862
Email steps are added to deployment processes in the same way as other steps.

0 commit comments

Comments
 (0)