6ed5cb5249
* website/integrations: rename "Create with Provider" to "New Application" The application list page now uses a split-button labeled "New Application" instead of the old "Create with Provider" dropdown. Update all 113 integration guides to match. * website/docs: update flow, stage, and policy button labels - "Create" → "New Flow", "New Stage", "New Policy" for trigger buttons - "Finish" → "Create Flow", "Create Stage", "Create Policy" for submit - "Create and bind stage" → "New Stage" / "Bind Existing Stage" - "Create" (binding submit) → "Create Stage Binding" * website/docs: update provider button labels - "Create" → "New Provider" for trigger buttons - "Create with Provider" → "New Application" in RAC docs - "Create" → "New Property Mapping", "New RAC Endpoint", "New Prompt" for related entity creation * website/docs: update directory button labels - "Create" → "New Source" for federation/social login pages - "Create" → "New Role", submit → "Create Role" - "Create" → "New Invitation" - Policy binding submit → "Create Policy Binding" * website/docs: update endpoint device and system management button labels - "Create" → "New Endpoint Connector", "New Enrollment Token", "New Device Access Group", "New Flow" - Submit → "Create Device Access Group" - "Create" → "New Notification Rule", "New Notification Transport" - Binding submit → "Create Policy Binding" * Reorganize policy documentation * website/docs: address policy docs review feedback * post-rebase * website/docs: Reorganize policy documentation -- Revisions (#21601) * apply suggestions * Fix escaped. * Fix whitespace. * Update button label. * Fix phrasing. * Fix phrasing. * Clean up stragglers. * Format. --------- Co-authored-by: Dominic R <dominic@sdko.org>
3.6 KiB
title, sidebar_label
| title | sidebar_label |
|---|---|
| Notification Rules | Notification Rules |
:::info To prevent infinite loops of cause and effect (events created by policies which are attached to a notification rule), any events created by a policy which is attached to any notification rules do not trigger notifications. :::
An authentik administrator can create notification rules based on the creation of specified events. Filtering of events is processed by the authentik Policy Engine, using a combination of both 1) a policy and 2) a notification rule.
Workflow overview
To receive notifications about events, follow this workflow:
- Create a notification transport (or use a default notification transport).
- Create a policy.
- Create a notification rule and bind the policy to the rule.
1. Create a notification transport
A notification transport determines the method used to deliver notifications to users. Supported delivery methods are: local notifications displayed in the authentik UI, email, and webhook. Follow these instructions to create a notification transport.
2. Create a policy
You will need to create a policy (either the Event Matcher policy or a custom Expression policy) that defines which events will trigger a notification.
Event Matcher policy
For simple event matching you can create and configure an Event Matcher Policy to define which events (known as Actions in the policy) will trigger a notification. For example, whenever a user deletes a model object, or whenever any user fails to successfully log in.
Be aware that an event has to match all configured fields in the policy, otherwise the notification rule will not trigger.
Expression policy for events
To match events with an Expression Policy, you can write code like so:
if "event" not in request.context:
return False
return ip_address(request.context["event"].client_ip) in ip_network('192.0.2.0/24')
For more code examples, see notification rule expression policies.
3. Create a notification rule and bind it to the policy
After you've created the policies to match the events you want, create a notification rule.
-
Log in as an administrator, open the authentik Admin interface, and navigate to Event > Notification Rules.
-
Click New Notification Rule to add a new notification rule or click the Edit icon next to an existing rule to modify it.
-
Define the policy configurations, and then click Create Notification Rule or Update to save the settings.
- Note that policies are executed regardless of whether a group is selected. However, notifications are only triggered when a group is selected.
- You also have to select which notification transport should be used to send the notification. Two notification transports are created by default:
default-email-transport: Delivers notifications via email using the global email configuration.default-local-transport: Delivers notifications within the authentik UI.
-
In the list of notification rules, click the arrow in the row of the notification rule to expand the details of the rule.
-
Click Bind existing Policy/Group/User and in the Create Binding modal, select the policy that you created for this notification rule and then click Create Policy Binding to finalize the binding.
:::info Be aware that policies are executed even when no group is selected. :::