

Enabling Notifications for User Operations¶

This feature is used to notify an external endpoint once a user operation has occurred.

For example, you may want to send an email to an email address once a new user is created or the password of an existing user is changed. This can be achieved by enabling notifications for user operations.

The configuration differs based on the type of notifications you want to send to the external endpoint. The following instructions provide information on how to send an email when a user operation takes place.

Prerequisites¶

You need to configure the email sending module in the deployment.toml file.

Add the email notification handler¶

To add the email notification handler onto the WSO2 IS pack:

Download the Email Notification Handler.
Add the downloaded org.wso2.carbon.identity.notification.mgt.email-x.x.x.jar file into the <IS_HOME>/repository/components/dropins directory.

Configure the notification management framework¶

Configure the <IS_HOME>/repository/conf/identity/msg-mgt.properties file with the desired destination and template configurations.

The following is a sample configuration for sending an email to an email address on a user operation event.

For example, user operations can include profile updates, account recovery, account locking/disabling, and asking for passwords.

module.name.1=email
email.subscription.1=userOperation
email.subscription.userOperation.template=/home/user/Desktop/user-operation-notification-template
# (If you are using a windows machine, the path would be C:\Users\Administrator\Desktop\user-operation-notification-template)
email.subscription.userOperation.subject=User operation change information
email.subscription.userOperation.endpoint.1=privateMail
email.subscription.userOperation.endpoint.privateMail.address=receiver@gmail.com
email.subscription.userOperation.endpoint.privateMail.salutation=Admin privateMail
email.subscription.userOperation.endpoint.privateMail.subject=User operation change information to private mail

Property	Description	Sample Value
`module.name.1`	This property is used to register the email-sending module in the notification management framework.	`email`
`email.subscription.1`	This property is used to identify when an email notification should be sent. The sample value is `userOperation`, which means that when a user operation happens, an event is triggered, and an email will be sent.	`userOperation`
`email.subscription.userOperation.template`	This property is used to locate the email template file. The email template file can have any file extension. Following is an example email template with placeholders which will be replaced with dynamic values that are coming from the event: `Hi {username} This is a test mail to your private mail. The operation occurred was: {operation}.`	`/home/wso2/user-event`
`email.subscription.userOperation.salutation`	This property is used to predefine the email's salutation. If you are using this property, you should change the `{username}` placeholder to `{salutation}` in the email template.	`Admin`
`email.subscription.userOperation.subject`	This property is used to define the email's subject.	`User operation change information`
`email.subscription.userOperation.endpoint.1`	This property is used to name the endpoint to which the emails will be sent.	`privateMail`
`email.subscription.userOperation.endpoint.privateMail.address`	This property is used to add the email address of the email receiver of the endpoint defined in the `email.subscription.userOperation.endpoint.1` property.	`[email protected]`
`email.subscription.userOperation.endpoint.privateMail.salutation`	This property is used to predefine the salutation of the email for the endpoint defined in the `email.subscription.userOperation.endpoint.1` property. If you are using this property, you should change the `{username}` placeholder to `{salutation}` in the email template.	`Admin privatemail`
`email.subscription.userOperation.endpoint.privateMail.subject`	This property is used to define the subject of the email specifically for the endpoint defined in the `email.subscription.userOperation.endpoint.1` property.	`User operation change information to private mail`

Top