14.2.1.8.2. User Notification Event Handler

class privacyidea.lib.eventhandler.usernotification.UserNotificationEventHandler[source]

An Eventhandler needs to return a list of actions, which it can handle.

It also returns a list of allowed action and conditions

It returns an identifier, which can be used in the eventhandlig definitions

actions

This method returns a dictionary of allowed actions and possible options in this handler module.

Returns:dict with actions
check_condition(options)[source]

Check if all conditions are met and if the action should be executed. The the conditions are met, we return “True” :return: True

conditions

The UserNotification can filter for conditions like * type of logged in user and * successful or failed value.success

allowed types are str, multi, text, regexp

Returns:dict
description = 'This eventhandler notifies the user about actions on his tokens'
do(action, options=None)[source]

This method executes the defined action in the given event.

Parameters:
  • action
  • options (dict) – Contains the flask parameters g, request, response and the handler_def configuration
Returns:

identifier = 'UserNotification'