Configuring sender details for email notifications
Understand how the hierarchical search works for the email notification sender details, and how you can configure sender details at the Space and Catalog level.
Before you begin
One of the following roles is required to configure sender details for email notifications:
- Administrator
- Owner
- A custom role with the
Cloud settings:Manage
orSettings:Manage
permission
About this task
- Cloud: emails are sent from the details that are configured in the Cloud Manager. section of the
- Org: the search for sender details starts at the Provider Organization level; if not available, the Cloud details are used.
- Catalog: the search for sender details starts at the Catalog level; if not available, the Org details are used, and if they're not available, the Cloud details are used.
- Space: the search for sender details starts at the Space level; if not available, the Catalog details are used, if they're not available, the Org details are used, and if they're not available, the Cloud details are used.
- Space or Catalog: in these cases the search starts at the Space level, or at the Catalog level,
depending on the user that made the request, as shown in the following list:
- When the product lifecycle change is started by a user in a Space, the search for sender details starts at the Space level.
- When the product lifecycle change is started by a user in a Catalog, the search for sender details starts at the Catalog level.
- When the product lifecycle change is approved by a user in a Space, the search for sender details starts at the Space level.
- When the product lifecycle change is approved by a user in a Catalog, the search for sender details starts at the Catalog level.
Scope | Template name | Email subject | Sender details |
---|---|---|---|
admin | mail-server-test-connection | Test message from IBM® API Connect. | Cloud |
admin | member-invitation | Invitation to an admin organization in IBM API Connect. | Cloud |
admin | password-changed | Password changed for your user account in IBM API Connect. | Cloud |
admin | password-reset | Password reset request for your user account in IBM API Connect. | Cloud |
provider | invitation | Invitation to create an API provider organization in IBM API Connect. | Cloud |
provider | member-invitation | Invitation to an API provider organization in IBM API Connect. | Org |
catalog | app-lifecycle-cancelled | Request withdrawn to {{action}} app {{appName}}. | Catalog |
catalog | app-lifecycle-request | Request for approval to {{action}} app {{appName}}. | Catalog |
catalog | invitation | Invitation to create an API catalog in IBM API Connect. | Org |
catalog | member-invitation | Invitation to an API catalog in IBM API Connect. | Catalog |
catalog | task-consumer-onboard-request | Consumer onboarding request in the {{catalog}} developer portal. | Catalog |
catalog | task-product-lifecycle-approved | Request approved to {{action}} API product in catalog {{catalog}}. | Space or Catalog |
catalog | task-product-lifecycle-cancelled | Request withdrawn to {{action}} an API product in the {{catalog}} catalog. | Space or Catalog |
catalog | task-product-lifecycle-denied | Request denied to {{action}} API product in catalog {{catalog}}. | Space or Catalog |
catalog | task-product-lifecycle-pending | Request received to {{action}} API product in catalog {{catalog}}. | Space or Catalog |
catalog | task-product-lifecycle-request | Request for approval to {{action}} an API product in the {{catalog}} catalog. | Space or Catalog |
catalog | task-subscription-cancelled | Request withdrawn to subscribe to an API product in the {{catalog}} catalog. | Catalog |
catalog | task-subscription-request | Request for approval to subscribe to an API product in the {{catalog}} catalog. | Catalog |
space | invitation | Invitation to create an API space in IBM API Connect. | Catalog |
space | member-invitation | Invitation to an API space in IBM API Connect. | Space |
consumer | account-approved | {{catalogTitle}} developer portal account registration is approved. | Catalog |
consumer | account-denied | {{catalogTitle}} developer portal account registration is denied. | Catalog |
consumer | account-pending-approval | {{catalogTitle}} developer portal account registration pending approval. | Catalog |
consumer | app-lifecycle-approved | Request approved to {{action}} app {{appName}}. | Catalog |
consumer | app-lifecycle-denied | Request denied to {{action}} app {{appName}}. | Catalog |
consumer | app-lifecycle-pending | Request received to {{action}} app {{appName}}. | Catalog |
consumer | app-reinstated | {{appName}} app reinstated in the {{consumerOrg}} developer portal. | Catalog |
consumer | app-suspended | {{appName}} app suspended in the {{consumerOrg}} developer portal. | Catalog |
consumer | invitation | Invitation to create an API consumer organization in the {{catalog}} developer portal. | Catalog |
consumer | member-invitation | Invitation to an API consumer organization in the {{catalog}} developer portal. | Catalog |
consumer | password-changed | Password changed for your user account in {{portalTitle}} developer portal. | Catalog |
consumer | password-reset | Password reset request for your {{catalog}} developer portal account. | Catalog |
consumer | sign-up | {{catalogTitle}} developer portal account registration. | Catalog |
consumer | task-subscription-approved | API subscription request approved for app {{appName}}. | Catalog |
consumer | task-subscription-denied | API subscription request denied for app {{appName}}. | Catalog |
consumer | task-subscription-pending | API subscription request received for app {{appName}}. | Catalog |
The sender address details can be configured at four levels: Cloud, Provider Organization, Catalog, and Space, and you can set a different sender address for each Provider Organization, Catalog, or Space, as required. The sender address for the Cloud can be configured in the Cloud Manager UI; see Setting up notifications for details. The sender address for the Provider Organization can be configured in the API Manager UI; see Configuring notifications for details. However, the sender address for Catalogs and Spaces can be configured only by using the toolkit CLI, as explained in the following steps.